blob: 02dd7c4314597f4b4d1e131b551d6812899cc261 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>FeatureInitializerFactory (Apache Commons Math 3.3 API)</title>
<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="FeatureInitializerFactory (Apache Commons Math 3.3 API)";
}
//-->
</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/FeatureInitializerFactory.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-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/MapUtils.html" title="class in org.apache.commons.math3.ml.neuralnet"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/commons/math3/ml/neuralnet/FeatureInitializerFactory.html" target="_top">Frames</a></li>
<li><a href="FeatureInitializerFactory.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>Constr&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>Constr&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.apache.commons.math3.ml.neuralnet</div>
<h2 title="Class FeatureInitializerFactory" class="title">Class FeatureInitializerFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.math3.ml.neuralnet.FeatureInitializerFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">FeatureInitializerFactory</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Creates functions that will select the initial values of a neuron's
features.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.3</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: FeatureInitializerFactory.java 1566092 2014-02-08 18:48:29Z tn $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>static <a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializerFactory.html#function(org.apache.commons.math3.analysis.UnivariateFunction, double, double)">function</a></strong>(<a href="../../../../../../org/apache/commons/math3/analysis/UnivariateFunction.html" title="interface in org.apache.commons.math3.analysis">UnivariateFunction</a>&nbsp;f,
double&nbsp;init,
double&nbsp;inc)</code>
<div class="block">Creates an initializer from a univariate function <code>f(x)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializerFactory.html#randomize(org.apache.commons.math3.distribution.RealDistribution, org.apache.commons.math3.ml.neuralnet.FeatureInitializer)">randomize</a></strong>(<a href="../../../../../../org/apache/commons/math3/distribution/RealDistribution.html" title="interface in org.apache.commons.math3.distribution">RealDistribution</a>&nbsp;random,
<a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a>&nbsp;orig)</code>
<div class="block">Adds some amount of random data to the given initializer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializerFactory.html#uniform(double, double)">uniform</a></strong>(double&nbsp;min,
double&nbsp;max)</code>
<div class="block">Uniform sampling of the given range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializerFactory.html#uniform(org.apache.commons.math3.random.RandomGenerator, double, double)">uniform</a></strong>(<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a>&nbsp;rng,
double&nbsp;min,
double&nbsp;max)</code>
<div class="block">Uniform sampling of the given range.</div>
</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.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="uniform(org.apache.commons.math3.random.RandomGenerator, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uniform</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a>&nbsp;uniform(<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a>&nbsp;rng,
double&nbsp;min,
double&nbsp;max)</pre>
<div class="block">Uniform sampling of the given range.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>min</code> - Lower bound of the range.</dd><dd><code>max</code> - Upper bound of the range.</dd><dd><code>rng</code> - Random number generator used to draw samples from a
uniform distribution.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an initializer such that the features will be initialized with
values within the given range.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>min &gt;= max</code>.</dd></dl>
</li>
</ul>
<a name="uniform(double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uniform</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a>&nbsp;uniform(double&nbsp;min,
double&nbsp;max)</pre>
<div class="block">Uniform sampling of the given range.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>min</code> - Lower bound of the range.</dd><dd><code>max</code> - Upper bound of the range.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an initializer such that the features will be initialized with
values within the given range.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>min &gt;= max</code>.</dd></dl>
</li>
</ul>
<a name="function(org.apache.commons.math3.analysis.UnivariateFunction, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>function</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a>&nbsp;function(<a href="../../../../../../org/apache/commons/math3/analysis/UnivariateFunction.html" title="interface in org.apache.commons.math3.analysis">UnivariateFunction</a>&nbsp;f,
double&nbsp;init,
double&nbsp;inc)</pre>
<div class="block">Creates an initializer from a univariate function <code>f(x)</code>.
The argument <code>x</code> is set to <code>init</code> at the first call
and will be incremented at each call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - Function.</dd><dd><code>init</code> - Initial value.</dd><dd><code>inc</code> - Increment</dd>
<dt><span class="strong">Returns:</span></dt><dd>the initializer.</dd></dl>
</li>
</ul>
<a name="randomize(org.apache.commons.math3.distribution.RealDistribution, org.apache.commons.math3.ml.neuralnet.FeatureInitializer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>randomize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a>&nbsp;randomize(<a href="../../../../../../org/apache/commons/math3/distribution/RealDistribution.html" title="interface in org.apache.commons.math3.distribution">RealDistribution</a>&nbsp;random,
<a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet">FeatureInitializer</a>&nbsp;orig)</pre>
<div class="block">Adds some amount of random data to the given initializer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>random</code> - Random variable distribution.</dd><dd><code>orig</code> - Original initializer.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an initializer whose <a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html#value()"><code>value</code></a>
method will return <code>orig.value() + random.sample()</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/FeatureInitializerFactory.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-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/FeatureInitializer.html" title="interface in org.apache.commons.math3.ml.neuralnet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/commons/math3/ml/neuralnet/MapUtils.html" title="class in org.apache.commons.math3.ml.neuralnet"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/commons/math3/ml/neuralnet/FeatureInitializerFactory.html" target="_top">Frames</a></li>
<li><a href="FeatureInitializerFactory.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2003&#x2013;2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>