diff options
Diffstat (limited to 'doc/org/unitConverter/unit/FunctionalUnit.html')
| -rw-r--r-- | doc/org/unitConverter/unit/FunctionalUnit.html | 504 |
1 files changed, 504 insertions, 0 deletions
diff --git a/doc/org/unitConverter/unit/FunctionalUnit.html b/doc/org/unitConverter/unit/FunctionalUnit.html new file mode 100644 index 0000000..fc0d446 --- /dev/null +++ b/doc/org/unitConverter/unit/FunctionalUnit.html @@ -0,0 +1,504 @@ +<!DOCTYPE HTML> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (11.0.4) on Thu Oct 24 10:48:04 EDT 2019 --> +<title>FunctionalUnit</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta name="dc.created" content="2019-10-24"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> +<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> +<!--[if IE]> +<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> +<![endif]--> +<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script> +<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script> +<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FunctionalUnit"; + } + } + catch(err) { + } +//--> +var data = {"i0":10,"i1":10,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +var pathtoroot = "../../../"; +var useModuleDirectories = true; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<header role="banner"> +<nav role="navigation"> +<div class="fixedNav"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a id="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FunctionalUnit.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" id="allclasses_navbar_top"> +<li><a href="../../../allclasses.html">All Classes</a></li> +</ul> +<ul class="navListSearch"> +<li><label for="search">SEARCH:</label> +<input type="text" id="search" value="search" disabled="disabled"> +<input type="reset" id="reset" value="reset" disabled="disabled"> +</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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +</nav> +</header> +<!-- ======== START OF CLASS DATA ======== --> +<main role="main"> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.unitConverter.unit</a></div> +<h2 title="Class FunctionalUnit" class="title">Class FunctionalUnit</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="Unit.html" title="class in org.unitConverter.unit">org.unitConverter.unit.Unit</a></li> +<li> +<ul class="inheritance"> +<li>org.unitConverter.unit.FunctionalUnit</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<pre>final class <span class="typeNameLabel">FunctionalUnit</span> +extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></pre> +<div class="block">A unit that uses functional objects to convert to and from its base.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Adrien Hopkins</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Field</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private java.util.function.DoubleUnaryOperator</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#converterFrom">converterFrom</a></span></code></th> +<td class="colLast"> +<div class="block">A function that accepts a value expressed in the unit's base and returns that value expressed in this unit.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private java.util.function.DoubleUnaryOperator</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#converterTo">converterTo</a></span></code></th> +<td class="colLast"> +<div class="block">A function that accepts a value expressed in the unit and returns that value expressed in the unit's base.</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colSecond" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private </code></td> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.unitConverter.math.ObjectProduct,java.util.function.DoubleUnaryOperator,java.util.function.DoubleUnaryOperator)">FunctionalUnit</a></span>​(<a href="../math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo)</code></th> +<td class="colLast"> +<div class="block">Creates the <code>FunctionalUnit</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ========== METHOD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>double</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertFromBase(double)">convertFromBase</a></span>​(double value)</code></th> +<td class="colLast"> +<div class="block">Converts from a value expressed in this unit's base unit to a value expressed in this unit.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>double</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertToBase(double)">convertToBase</a></span>​(double value)</code></th> +<td class="colLast"> +<div class="block">Converts from a value expressed in this unit to a value expressed in this unit's base unit.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="FunctionalUnit.html" title="class in org.unitConverter.unit">FunctionalUnit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(org.unitConverter.math.ObjectProduct,java.util.function.DoubleUnaryOperator,java.util.function.DoubleUnaryOperator)">valueOf</a></span>​(<a href="../math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo)</code></th> +<td class="colLast"> +<div class="block">Returns a unit from its base and the functions it uses to convert to and from its base.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.org.unitConverter.unit.Unit"> +<!-- --> +</a> +<h3>Methods inherited from class org.unitConverter.unit.<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></h3> +<code><a href="Unit.html#canConvertTo(org.unitConverter.unit.Unit)">canConvertTo</a>, <a href="Unit.html#convertTo(org.unitConverter.unit.Unit,double)">convertTo</a>, <a href="Unit.html#fromConversionFunctions(org.unitConverter.math.ObjectProduct,java.util.function.DoubleUnaryOperator,java.util.function.DoubleUnaryOperator)">fromConversionFunctions</a>, <a href="Unit.html#getBase()">getBase</a>, <a href="Unit.html#getDimension()">getDimension</a>, <a href="Unit.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a id="converterFrom"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>converterFrom</h4> +<pre>private final java.util.function.DoubleUnaryOperator converterFrom</pre> +<div class="block">A function that accepts a value expressed in the unit's base and returns that value expressed in this unit.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +</dl> +</li> +</ul> +<a id="converterTo"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>converterTo</h4> +<pre>private final java.util.function.DoubleUnaryOperator converterTo</pre> +<div class="block">A function that accepts a value expressed in the unit and returns that value expressed in the unit's base.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a id="<init>(org.unitConverter.math.ObjectProduct,java.util.function.DoubleUnaryOperator,java.util.function.DoubleUnaryOperator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FunctionalUnit</h4> +<pre>private FunctionalUnit​(<a href="../math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo)</pre> +<div class="block">Creates the <code>FunctionalUnit</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>base</code> - unit's base</dd> +<dd><code>converterFrom</code> - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.</dd> +<dd><code>converterTo</code> - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if any argument is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +<!-- ============ METHOD DETAIL ========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a id="valueOf(org.unitConverter.math.ObjectProduct,java.util.function.DoubleUnaryOperator,java.util.function.DoubleUnaryOperator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre class="methodSignature">public static <a href="FunctionalUnit.html" title="class in org.unitConverter.unit">FunctionalUnit</a> valueOf​(<a href="../math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo)</pre> +<div class="block">Returns a unit from its base and the functions it uses to convert to and from its base.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>base</code> - unit's base</dd> +<dd><code>converterFrom</code> - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.</dd> +<dd><code>converterTo</code> - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a unit that uses the provided functions to convert.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if any argument is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +</dl> +</li> +</ul> +<a id="convertFromBase(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertFromBase</h4> +<pre class="methodSignature">public double convertFromBase​(double value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Unit.html#convertFromBase(double)">Unit</a></code></span></div> +<div class="block">Converts from a value expressed in this unit's base unit to a value expressed in this unit. + <p> + This must be the inverse of <code>convertToBase</code>, so <code>convertFromBase(convertToBase(value))</code> must be equal + to <code>value</code> for any value, ignoring precision loss by roundoff error. + </p> + <p> + If this unit <i>is</i> a base unit, this method should return <code>value</code>. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="Unit.html#convertFromBase(double)">convertFromBase</a></code> in class <code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - value expressed in <b>base</b> unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value expressed in <b>this</b> unit</dd> +</dl> +</li> +</ul> +<a id="convertToBase(double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>convertToBase</h4> +<pre class="methodSignature">public double convertToBase​(double value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Unit.html#convertToBase(double)">Unit</a></code></span></div> +<div class="block">Converts from a value expressed in this unit to a value expressed in this unit's base unit. + <p> + This must be the inverse of <code>convertFromBase</code>, so <code>convertToBase(convertFromBase(value))</code> must be + equal to <code>value</code> for any value, ignoring precision loss by roundoff error. + </p> + <p> + If this unit <i>is</i> a base unit, this method should return <code>value</code>. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="Unit.html#convertToBase(double)">convertToBase</a></code> in class <code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - value expressed in <b>this</b> unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value expressed in <b>base</b> unit</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +</div> +</main> +<!-- ========= END OF CLASS DATA ========= --> +<footer role="contentinfo"> +<nav role="navigation"> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a id="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FunctionalUnit.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" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses.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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</nav> +</footer> +</body> +</html> |