Mercurial > hg > semantic-sia

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