Mercurial > hg > semantic-sia

diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html	Tue Jan 01 21:18:46 2013 +0000
@@ -0,0 +1,313 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_09) on Tue Jan 01 21:05:06 GMT 2013 -->
+<title>NDimensionalObject</title>
+<meta name="date" content="2013-01-01">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+    if (location.href.indexOf('is-external=true') == -1) {
+        parent.document.title="NDimensionalObject";
+    }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!--   -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/NDimensionalObject.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<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>
+<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>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html" target="_top">Frames</a></li>
+<li><a href="NDimensionalObject.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.qmul.eecs.c4dm.sia.model</div>
+<h2 title="Class NDimensionalObject" class="title">Class NDimensionalObject</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.qmul.eecs.c4dm.sia.model.NDimensionalObject</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.lang.Comparable</dd>
+</dl>
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<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>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">NDimensionalObject</span>
+extends java.lang.Object
+implements java.lang.Comparable</pre>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!--   -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#NDimensionalObject()">NDimensionalObject</a></strong>()</code>&nbsp;</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!--   -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<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>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>double</code></td>
+<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>
+</tr>
+<tr class="altColor">
+<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>
+<td class="colLast"><code><strong><a href="../../../../../../org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html#getDimensionValues()">getDimensionValues</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<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>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
+<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!--   -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="NDimensionalObject()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>NDimensionalObject</h4>
+<pre>public&nbsp;NDimensionalObject()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="getDimensionValues()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDimensionValues</h4>
+<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>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the dimensionValue</dd></dl>
+</li>
+</ul>
+<a name="setDimensionValues(java.util.Vector)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDimensionValues</h4>
+<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>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dimensionValue</code> - the dimensionValue to set</dd></dl>
+</li>
+</ul>
+<a name="getDimensionValue(int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDimensionValue</h4>
+<pre>public&nbsp;double&nbsp;getDimensionValue(int&nbsp;dimension)
+                         throws <a href="../../../../../../org/qmul/eecs/c4dm/sia/exceptions/DimensionException.html" title="class in org.qmul.eecs.c4dm.sia.exceptions">DimensionException</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<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>
+</li>
+</ul>
+<a name="compareTo(java.lang.Object)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>compareTo</h4>
+<pre>public&nbsp;int&nbsp;compareTo(java.lang.Object&nbsp;o2)</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable</code></dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!--   -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/NDimensionalObject.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<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>
+<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>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/qmul/eecs/c4dm/sia/model/NDimensionalObject.html" target="_top">Frames</a></li>
+<li><a href="NDimensionalObject.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>