| <!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 (1.8.0_342) on Sat Oct 15 20:26:59 UTC 2022 --> |
| <title>Param (Spark 3.3.1 JavaDoc)</title> |
| <meta name="date" content="2022-10-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Param (Spark 3.3.1 JavaDoc)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/spark/ml/param/Param.html" target="_top">Frames</a></li> |
| <li><a href="Param.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: </li> |
| <li>Nested | </li> |
| <li>Field | </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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.spark.ml.param</div> |
| <h2 title="Class Param" class="title">Class Param<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.spark.ml.param.Param<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - param value type</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a>, <a href="../../../../../org/apache/spark/ml/param/DoubleArrayArrayParam.html" title="class in org.apache.spark.ml.param">DoubleArrayArrayParam</a>, <a href="../../../../../org/apache/spark/ml/param/DoubleArrayParam.html" title="class in org.apache.spark.ml.param">DoubleArrayParam</a>, <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a>, <a href="../../../../../org/apache/spark/ml/param/FloatParam.html" title="class in org.apache.spark.ml.param">FloatParam</a>, <a href="../../../../../org/apache/spark/ml/param/IntArrayParam.html" title="class in org.apache.spark.ml.param">IntArrayParam</a>, <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>, <a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a>, <a href="../../../../../org/apache/spark/ml/param/StringArrayParam.html" title="class in org.apache.spark.ml.param">StringArrayParam</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Param<T></span> |
| extends Object |
| implements scala.Serializable</pre> |
| <div class="block">A param with self-contained documentation and optionally default value. Primitive-typed param |
| should use the specialized versions, which are more friendly to Java users. |
| <p> |
| param: parent parent object |
| param: name param name |
| param: doc documentation |
| param: isValid optional validation method which indicates if a value is valid. |
| See <a href="../../../../../org/apache/spark/ml/param/ParamValidators.html" title="class in org.apache.spark.ml.param"><code>ParamValidators</code></a> for factory methods for common validation functions.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.param.Param">Serialized Form</a></dd> |
| </dl> |
| </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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#Param-org.apache.spark.ml.util.Identifiable-java.lang.String-java.lang.String-">Param</a></span>(<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a> parent, |
| String name, |
| String doc)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#Param-org.apache.spark.ml.util.Identifiable-java.lang.String-java.lang.String-scala.Function1-">Param</a></span>(<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a> parent, |
| String name, |
| String doc, |
| scala.Function1<<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>,Object> isValid)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#Param-java.lang.String-java.lang.String-java.lang.String-">Param</a></span>(String parent, |
| String name, |
| String doc)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#Param-java.lang.String-java.lang.String-java.lang.String-scala.Function1-">Param</a></span>(String parent, |
| String name, |
| String doc, |
| scala.Function1<<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>,Object> isValid)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#doc--">doc</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#equals-java.lang.Object-">equals</a></span>(Object obj)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>scala.Function1<<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>,Object></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#isValid--">isValid</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#jsonDecode-java.lang.String-">jsonDecode</a></span>(String json)</code> |
| <div class="block">Decodes a param value from JSON.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#jsonEncode-T-">jsonEncode</a></span>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a> value)</code> |
| <div class="block">Encodes a param value into JSON, which can be decoded by `jsonDecode()`.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#name--">name</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#parent--">parent</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/param/Param.html#w-T-">w</a></span>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a> value)</code> |
| <div class="block">Creates a param pair with the given value (for Java).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class Object</h3> |
| <code>getClass, notify, notifyAll, 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="Param-java.lang.String-java.lang.String-java.lang.String-scala.Function1-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Param</h4> |
| <pre>public Param(String parent, |
| String name, |
| String doc, |
| scala.Function1<<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>,Object> isValid)</pre> |
| </li> |
| </ul> |
| <a name="Param-org.apache.spark.ml.util.Identifiable-java.lang.String-java.lang.String-scala.Function1-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Param</h4> |
| <pre>public Param(<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a> parent, |
| String name, |
| String doc, |
| scala.Function1<<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>,Object> isValid)</pre> |
| </li> |
| </ul> |
| <a name="Param-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Param</h4> |
| <pre>public Param(String parent, |
| String name, |
| String doc)</pre> |
| </li> |
| </ul> |
| <a name="Param-org.apache.spark.ml.util.Identifiable-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Param</h4> |
| <pre>public Param(<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a> parent, |
| String name, |
| String doc)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="parent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parent</h4> |
| <pre>public String parent()</pre> |
| </li> |
| </ul> |
| <a name="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public String name()</pre> |
| </li> |
| </ul> |
| <a name="doc--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doc</h4> |
| <pre>public String doc()</pre> |
| </li> |
| </ul> |
| <a name="isValid--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre>public scala.Function1<<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>,Object> isValid()</pre> |
| </li> |
| </ul> |
| <a name="w-java.lang.Object-"> |
| <!-- --> |
| </a><a name="w-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>w</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a>> w(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a> value)</pre> |
| <div class="block">Creates a param pair with the given value (for Java).</div> |
| </li> |
| </ul> |
| <a name="jsonEncode-java.lang.Object-"> |
| <!-- --> |
| </a><a name="jsonEncode-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jsonEncode</h4> |
| <pre>public String jsonEncode(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a> value)</pre> |
| <div class="block">Encodes a param value into JSON, which can be decoded by `jsonDecode()`.</div> |
| </li> |
| </ul> |
| <a name="jsonDecode-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jsonDecode</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/param/Param.html" title="type parameter in Param">T</a> jsonDecode(String json)</pre> |
| <div class="block">Decodes a param value from JSON.</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public final String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public final int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public final boolean equals(Object obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>Object</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/spark/ml/param/Param.html" target="_top">Frames</a></li> |
| <li><a href="Param.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: </li> |
| <li>Nested | </li> |
| <li>Field | </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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body> |
| </html> |
