Mercurial > hg > semantic-sia

annotate doc/org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html @ 9:3dc7ce380afe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
new
author stevenh
date Tue, 01 Jan 2013 21:18:46 +0000
parents
children
rev   line source
stevenh@9 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
stevenh@9 2 <!-- NewPage -->
stevenh@9 3 <html lang="en">
stevenh@9 4 <head>
stevenh@9 5 <!-- Generated by javadoc (version 1.7.0_09) on Tue Jan 01 21:05:06 GMT 2013 -->
stevenh@9 6 <title>NDimensionalObject</title>
stevenh@9 7 <meta name="date" content="2013-01-01">
stevenh@9 8 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
stevenh@9 9 </head>
stevenh@9 10 <body>
stevenh@9 11 <script type="text/javascript"><!--
stevenh@9 12 if (location.href.indexOf('is-external=true') == -1) {
stevenh@9 13 parent.document.title="NDimensionalObject";
stevenh@9 14 }
stevenh@9 15 //-->
stevenh@9 16 </script>
stevenh@9 17 <noscript>
stevenh@9 18 <div>JavaScript is disabled on your browser.</div>
stevenh@9 19 </noscript>
stevenh@9 20 <!-- ========= START OF TOP NAVBAR ======= -->
stevenh@9 21 <div class="topNav"><a name="navbar_top">
stevenh@9 22 <!-- -->
stevenh@9 23 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
stevenh@9 24 <!-- -->
stevenh@9 25 </a>
stevenh@9 26 <ul class="navList" title="Navigation">
stevenh@9 27 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
stevenh@9 28 <li><a href="package-summary.html">Package</a></li>
stevenh@9 29 <li class="navBarCell1Rev">Class</li>
stevenh@9 30 <li><a href="class-use/NDimensionalObject.html">Use</a></li>
stevenh@9 31 <li><a href="package-tree.html">Tree</a></li>
stevenh@9 32 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
stevenh@9 33 <li><a href="../../../../../../index-files/index-1.html">Index</a></li>
stevenh@9 34 <li><a href="../../../../../../help-doc.html">Help</a></li>
stevenh@9 35 </ul>
stevenh@9 36 </div>
stevenh@9 37 <div class="subNav">
stevenh@9 38 <ul class="navList">
stevenh@9 39 <li><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/MemberOfOrderedSet.html" title="class in org.qmul.eecs.c4dm.sia.model"><span class="strong">Prev Class</span></a></li>
stevenh@9 40 <li><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/OrderedIndex.html" title="class in org.qmul.eecs.c4dm.sia.model"><span class="strong">Next Class</span></a></li>
stevenh@9 41 </ul>
stevenh@9 42 <ul class="navList">
stevenh@9 43 <li><a href="../../../../../../index.html?org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html" target="_top">Frames</a></li>
stevenh@9 44 <li><a href="NDimensionalObject.html" target="_top">No Frames</a></li>
stevenh@9 45 </ul>
stevenh@9 46 <ul class="navList" id="allclasses_navbar_top">
stevenh@9 47 <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
stevenh@9 48 </ul>
stevenh@9 49 <div>
stevenh@9 50 <script type="text/javascript"><!--
stevenh@9 51 allClassesLink = document.getElementById("allclasses_navbar_top");
stevenh@9 52 if(window==top) {
stevenh@9 53 allClassesLink.style.display = "block";
stevenh@9 54 }
stevenh@9 55 else {
stevenh@9 56 allClassesLink.style.display = "none";
stevenh@9 57 }
stevenh@9 58 //-->
stevenh@9 59 </script>
stevenh@9 60 </div>
stevenh@9 61 <div>
stevenh@9 62 <ul class="subNavList">
stevenh@9 63 <li>Summary:&nbsp;</li>
stevenh@9 64 <li>Nested&nbsp;|&nbsp;</li>
stevenh@9 65 <li>Field&nbsp;|&nbsp;</li>
stevenh@9 66 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
stevenh@9 67 <li><a href="#method_summary">Method</a></li>
stevenh@9 68 </ul>
stevenh@9 69 <ul class="subNavList">
stevenh@9 70 <li>Detail:&nbsp;</li>
stevenh@9 71 <li>Field&nbsp;|&nbsp;</li>
stevenh@9 72 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
stevenh@9 73 <li><a href="#method_detail">Method</a></li>
stevenh@9 74 </ul>
stevenh@9 75 </div>
stevenh@9 76 <a name="skip-navbar_top">
stevenh@9 77 <!-- -->
stevenh@9 78 </a></div>
stevenh@9 79 <!-- ========= END OF TOP NAVBAR ========= -->
stevenh@9 80 <!-- ======== START OF CLASS DATA ======== -->
stevenh@9 81 <div class="header">
stevenh@9 82 <div class="subTitle">org.qmul.eecs.c4dm.sia.model</div>
stevenh@9 83 <h2 title="Class NDimensionalObject" class="title">Class NDimensionalObject</h2>
stevenh@9 84 </div>
stevenh@9 85 <div class="contentContainer">
stevenh@9 86 <ul class="inheritance">
stevenh@9 87 <li>java.lang.Object</li>
stevenh@9 88 <li>
stevenh@9 89 <ul class="inheritance">
stevenh@9 90 <li>org.qmul.eecs.c4dm.sia.model.NDimensionalObject</li>
stevenh@9 91 </ul>
stevenh@9 92 </li>
stevenh@9 93 </ul>
stevenh@9 94 <div class="description">
stevenh@9 95 <ul class="blockList">
stevenh@9 96 <li class="blockList">
stevenh@9 97 <dl>
stevenh@9 98 <dt>All Implemented Interfaces:</dt>
stevenh@9 99 <dd>java.lang.Comparable</dd>
stevenh@9 100 </dl>
stevenh@9 101 <dl>
stevenh@9 102 <dt>Direct Known Subclasses:</dt>
stevenh@9 103 <dd><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/Datapoint.html" title="class in org.qmul.eecs.c4dm.sia.model">Datapoint</a>, <a href="../../../../../../org/qmul/eecs/c4dm/sia/model/VectorTableElement.html" title="class in org.qmul.eecs.c4dm.sia.model">VectorTableElement</a></dd>
stevenh@9 104 </dl>
stevenh@9 105 <hr>
stevenh@9 106 <br>
stevenh@9 107 <pre>public class <span class="strong">NDimensionalObject</span>
stevenh@9 108 extends java.lang.Object
stevenh@9 109 implements java.lang.Comparable</pre>
stevenh@9 110 </li>
stevenh@9 111 </ul>
stevenh@9 112 </div>
stevenh@9 113 <div class="summary">
stevenh@9 114 <ul class="blockList">
stevenh@9 115 <li class="blockList">
stevenh@9 116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
stevenh@9 117 <ul class="blockList">
stevenh@9 118 <li class="blockList"><a name="constructor_summary">
stevenh@9 119 <!-- -->
stevenh@9 120 </a>
stevenh@9 121 <h3>Constructor Summary</h3>
stevenh@9 122 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
stevenh@9 123 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
stevenh@9 124 <tr>
stevenh@9 125 <th class="colOne" scope="col">Constructor and Description</th>
stevenh@9 126 </tr>
stevenh@9 127 <tr class="altColor">
stevenh@9 128 <td class="colOne"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#NDimensionalObject()">NDimensionalObject</a></strong>()</code>&nbsp;</td>
stevenh@9 129 </tr>
stevenh@9 130 </table>
stevenh@9 131 </li>
stevenh@9 132 </ul>
stevenh@9 133 <!-- ========== METHOD SUMMARY =========== -->
stevenh@9 134 <ul class="blockList">
stevenh@9 135 <li class="blockList"><a name="method_summary">
stevenh@9 136 <!-- -->
stevenh@9 137 </a>
stevenh@9 138 <h3>Method Summary</h3>
stevenh@9 139 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
stevenh@9 140 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
stevenh@9 141 <tr>
stevenh@9 142 <th class="colFirst" scope="col">Modifier and Type</th>
stevenh@9 143 <th class="colLast" scope="col">Method and Description</th>
stevenh@9 144 </tr>
stevenh@9 145 <tr class="altColor">
stevenh@9 146 <td class="colFirst"><code>int</code></td>
stevenh@9 147 <td class="colLast"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#compareTo(java.lang.Object)">compareTo</a></strong>(java.lang.Object&nbsp;o2)</code>&nbsp;</td>
stevenh@9 148 </tr>
stevenh@9 149 <tr class="rowColor">
stevenh@9 150 <td class="colFirst"><code>double</code></td>
stevenh@9 151 <td class="colLast"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#getDimensionValue(int)">getDimensionValue</a></strong>(int&nbsp;dimension)</code>&nbsp;</td>
stevenh@9 152 </tr>
stevenh@9 153 <tr class="altColor">
stevenh@9 154 <td class="colFirst"><code>java.util.Vector&lt;<a href="../../../../../../org/qmul/eecs/c4dm/sia/model/DimensionValue.html" title="class in org.qmul.eecs.c4dm.sia.model">DimensionValue</a>&gt;</code></td>
stevenh@9 155 <td class="colLast"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#getDimensionValues()">getDimensionValues</a></strong>()</code>&nbsp;</td>
stevenh@9 156 </tr>
stevenh@9 157 <tr class="rowColor">
stevenh@9 158 <td class="colFirst"><code>void</code></td>
stevenh@9 159 <td class="colLast"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#setDimensionValues(java.util.Vector)">setDimensionValues</a></strong>(java.util.Vector&lt;<a href="../../../../../../org/qmul/eecs/c4dm/sia/model/DimensionValue.html" title="class in org.qmul.eecs.c4dm.sia.model">DimensionValue</a>&gt;&nbsp;dimensionValues)</code>&nbsp;</td>
stevenh@9 160 </tr>
stevenh@9 161 </table>
stevenh@9 162 <ul class="blockList">
stevenh@9 163 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
stevenh@9 164 <!-- -->
stevenh@9 165 </a>
stevenh@9 166 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
stevenh@9 167 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
stevenh@9 168 </ul>
stevenh@9 169 </li>
stevenh@9 170 </ul>
stevenh@9 171 </li>
stevenh@9 172 </ul>
stevenh@9 173 </div>
stevenh@9 174 <div class="details">
stevenh@9 175 <ul class="blockList">
stevenh@9 176 <li class="blockList">
stevenh@9 177 <!-- ========= CONSTRUCTOR DETAIL ======== -->
stevenh@9 178 <ul class="blockList">
stevenh@9 179 <li class="blockList"><a name="constructor_detail">
stevenh@9 180 <!-- -->
stevenh@9 181 </a>
stevenh@9 182 <h3>Constructor Detail</h3>
stevenh@9 183 <a name="NDimensionalObject()">
stevenh@9 184 <!-- -->
stevenh@9 185 </a>
stevenh@9 186 <ul class="blockListLast">
stevenh@9 187 <li class="blockList">
stevenh@9 188 <h4>NDimensionalObject</h4>
stevenh@9 189 <pre>public&nbsp;NDimensionalObject()</pre>
stevenh@9 190 </li>
stevenh@9 191 </ul>
stevenh@9 192 </li>
stevenh@9 193 </ul>
stevenh@9 194 <!-- ============ METHOD DETAIL ========== -->
stevenh@9 195 <ul class="blockList">
stevenh@9 196 <li class="blockList"><a name="method_detail">
stevenh@9 197 <!-- -->
stevenh@9 198 </a>
stevenh@9 199 <h3>Method Detail</h3>
stevenh@9 200 <a name="getDimensionValues()">
stevenh@9 201 <!-- -->
stevenh@9 202 </a>
stevenh@9 203 <ul class="blockList">
stevenh@9 204 <li class="blockList">
stevenh@9 205 <h4>getDimensionValues</h4>
stevenh@9 206 <pre>public&nbsp;java.util.Vector&lt;<a href="../../../../../../org/qmul/eecs/c4dm/sia/model/DimensionValue.html" title="class in org.qmul.eecs.c4dm.sia.model">DimensionValue</a>&gt;&nbsp;getDimensionValues()</pre>
stevenh@9 207 <dl><dt><span class="strong">Returns:</span></dt><dd>the dimensionValue</dd></dl>
stevenh@9 208 </li>
stevenh@9 209 </ul>
stevenh@9 210 <a name="setDimensionValues(java.util.Vector)">
stevenh@9 211 <!-- -->
stevenh@9 212 </a>
stevenh@9 213 <ul class="blockList">
stevenh@9 214 <li class="blockList">
stevenh@9 215 <h4>setDimensionValues</h4>
stevenh@9 216 <pre>public&nbsp;void&nbsp;setDimensionValues(java.util.Vector&lt;<a href="../../../../../../org/qmul/eecs/c4dm/sia/model/DimensionValue.html" title="class in org.qmul.eecs.c4dm.sia.model">DimensionValue</a>&gt;&nbsp;dimensionValues)</pre>
stevenh@9 217 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dimensionValue</code> - the dimensionValue to set</dd></dl>
stevenh@9 218 </li>
stevenh@9 219 </ul>
stevenh@9 220 <a name="getDimensionValue(int)">
stevenh@9 221 <!-- -->
stevenh@9 222 </a>
stevenh@9 223 <ul class="blockList">
stevenh@9 224 <li class="blockList">
stevenh@9 225 <h4>getDimensionValue</h4>
stevenh@9 226 <pre>public&nbsp;double&nbsp;getDimensionValue(int&nbsp;dimension)
stevenh@9 227 throws <a href="../../../../../../org/qmul/eecs/c4dm/sia/exceptions/DimensionException.html" title="class in org.qmul.eecs.c4dm.sia.exceptions">DimensionException</a></pre>
stevenh@9 228 <dl><dt><span class="strong">Throws:</span></dt>
stevenh@9 229 <dd><code><a href="../../../../../../org/qmul/eecs/c4dm/sia/exceptions/DimensionException.html" title="class in org.qmul.eecs.c4dm.sia.exceptions">DimensionException</a></code></dd></dl>
stevenh@9 230 </li>
stevenh@9 231 </ul>
stevenh@9 232 <a name="compareTo(java.lang.Object)">
stevenh@9 233 <!-- -->
stevenh@9 234 </a>
stevenh@9 235 <ul class="blockListLast">
stevenh@9 236 <li class="blockList">
stevenh@9 237 <h4>compareTo</h4>
stevenh@9 238 <pre>public&nbsp;int&nbsp;compareTo(java.lang.Object&nbsp;o2)</pre>
stevenh@9 239 <dl>
stevenh@9 240 <dt><strong>Specified by:</strong></dt>
stevenh@9 241 <dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable</code></dd>
stevenh@9 242 </dl>
stevenh@9 243 </li>
stevenh@9 244 </ul>
stevenh@9 245 </li>
stevenh@9 246 </ul>
stevenh@9 247 </li>
stevenh@9 248 </ul>
stevenh@9 249 </div>
stevenh@9 250 </div>
stevenh@9 251 <!-- ========= END OF CLASS DATA ========= -->
stevenh@9 252 <!-- ======= START OF BOTTOM NAVBAR ====== -->
stevenh@9 253 <div class="bottomNav"><a name="navbar_bottom">
stevenh@9 254 <!-- -->
stevenh@9 255 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
stevenh@9 256 <!-- -->
stevenh@9 257 </a>
stevenh@9 258 <ul class="navList" title="Navigation">
stevenh@9 259 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
stevenh@9 260 <li><a href="package-summary.html">Package</a></li>
stevenh@9 261 <li class="navBarCell1Rev">Class</li>
stevenh@9 262 <li><a href="class-use/NDimensionalObject.html">Use</a></li>
stevenh@9 263 <li><a href="package-tree.html">Tree</a></li>
stevenh@9 264 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
stevenh@9 265 <li><a href="../../../../../../index-files/index-1.html">Index</a></li>
stevenh@9 266 <li><a href="../../../../../../help-doc.html">Help</a></li>
stevenh@9 267 </ul>
stevenh@9 268 </div>
stevenh@9 269 <div class="subNav">
stevenh@9 270 <ul class="navList">
stevenh@9 271 <li><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/MemberOfOrderedSet.html" title="class in org.qmul.eecs.c4dm.sia.model"><span class="strong">Prev Class</span></a></li>
stevenh@9 272 <li><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/OrderedIndex.html" title="class in org.qmul.eecs.c4dm.sia.model"><span class="strong">Next Class</span></a></li>
stevenh@9 273 </ul>
stevenh@9 274 <ul class="navList">
stevenh@9 275 <li><a href="../../../../../../index.html?org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html" target="_top">Frames</a></li>
stevenh@9 276 <li><a href="NDimensionalObject.html" target="_top">No Frames</a></li>
stevenh@9 277 </ul>
stevenh@9 278 <ul class="navList" id="allclasses_navbar_bottom">
stevenh@9 279 <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
stevenh@9 280 </ul>
stevenh@9 281 <div>
stevenh@9 282 <script type="text/javascript"><!--
stevenh@9 283 allClassesLink = document.getElementById("allclasses_navbar_bottom");
stevenh@9 284 if(window==top) {
stevenh@9 285 allClassesLink.style.display = "block";
stevenh@9 286 }
stevenh@9 287 else {
stevenh@9 288 allClassesLink.style.display = "none";
stevenh@9 289 }
stevenh@9 290 //-->
stevenh@9 291 </script>
stevenh@9 292 </div>
stevenh@9 293 <div>
stevenh@9 294 <ul class="subNavList">
stevenh@9 295 <li>Summary:&nbsp;</li>
stevenh@9 296 <li>Nested&nbsp;|&nbsp;</li>
stevenh@9 297 <li>Field&nbsp;|&nbsp;</li>
stevenh@9 298 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
stevenh@9 299 <li><a href="#method_summary">Method</a></li>
stevenh@9 300 </ul>
stevenh@9 301 <ul class="subNavList">
stevenh@9 302 <li>Detail:&nbsp;</li>
stevenh@9 303 <li>Field&nbsp;|&nbsp;</li>
stevenh@9 304 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
stevenh@9 305 <li><a href="#method_detail">Method</a></li>
stevenh@9 306 </ul>
stevenh@9 307 </div>
stevenh@9 308 <a name="skip-navbar_bottom">
stevenh@9 309 <!-- -->
stevenh@9 310 </a></div>
stevenh@9 311 <!-- ======== END OF BOTTOM NAVBAR ======= -->
stevenh@9 312 </body>
stevenh@9 313 </html>