|
|
<!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_51) on Wed Sep 16 10:26:35 PDT 2015 -->
<title>ParamMap</title>
<meta name="date" content="2015-09-16">
<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="ParamMap";
}
//-->
</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="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/Param.html" title="class in org.apache.spark.ml.param"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/param/ParamMap.html" target="_top">Frames</a></li>
<li><a href="ParamMap.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 ParamMap" class="title">Class ParamMap</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.param.ParamMap</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">ParamMap</span>
extends java.lang.Object
implements scala.Serializable</pre>
<div class="block">:: Experimental ::
A param to value map.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.param.ParamMap">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="overviewSummary" 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><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#ParamMap()">ParamMap</a></strong>()</code>
<div class="block">Creates an empty param map.</div>
</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"> </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><T> T</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#apply(org.apache.spark.ml.param.Param)">apply</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param)</code>
<div class="block">Gets the value of the input param or its default value if it does not exist.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#contains(org.apache.spark.ml.param.Param)">contains</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><?> param)</code>
<div class="block">Checks whether a parameter is explicitly specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#copy()">copy</a></strong>()</code>
<div class="block">Creates a copy of this param map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#empty()">empty</a></strong>()</code>
<div class="block">Returns an empty param map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#filter(org.apache.spark.ml.param.Params)">filter</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a> parent)</code>
<div class="block">Filters this param map for the given parent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> scala.Option<T></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#get(org.apache.spark.ml.param.Param)">get</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param)</code>
<div class="block">Optionally returns the value associated with a param.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T> T</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#getOrElse(org.apache.spark.ml.param.Param, T)">getOrElse</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param,
T default_)</code>
<div class="block">Returns the value associated with a param or a default value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#put(org.apache.spark.ml.param.Param, T)">put</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param,
T value)</code>
<div class="block">Puts a (param, value) pair (overwrites if the input param exists).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#put(org.apache.spark.ml.param.ParamPair...)">put</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>... paramPairs)</code>
<div class="block">Puts a list of param pairs (overwrites if the input params exists).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#put(scala.collection.Seq)">put</a></strong>(scala.collection.Seq<<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>> paramPairs)</code>
<div class="block">Puts a list of param pairs (overwrites if the input params exists).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T> scala.Option<T></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#remove(org.apache.spark.ml.param.Param)">remove</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param)</code>
<div class="block">Removes a key from this map and returns its value associated previously as an option.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#size()">size</a></strong>()</code>
<div class="block">Number of param pairs in this map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.collection.Seq<<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#toSeq()">toSeq</a></strong>()</code>
<div class="block">Converts this param map to a sequence of param pairs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/ParamMap.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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>
</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="ParamMap()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParamMap</h4>
<pre>public ParamMap()</pre>
<div class="block">Creates an empty param map.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="empty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>empty</h4>
<pre>public static <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> empty()</pre>
<div class="block">Returns an empty param map.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="put(org.apache.spark.ml.param.ParamPair...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> put(<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>... paramPairs)</pre>
<div class="block">Puts a list of param pairs (overwrites if the input params exists).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramPairs</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="put(org.apache.spark.ml.param.Param,java.lang.Object)">
<!-- -->
</a><a name="put(org.apache.spark.ml.param.Param, T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public <T> <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> put(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param,
T value)</pre>
<div class="block">Puts a (param, value) pair (overwrites if the input param exists).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="put(scala.collection.Seq)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> put(scala.collection.Seq<<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>> paramPairs)</pre>
<div class="block">Puts a list of param pairs (overwrites if the input params exists).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramPairs</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="get(org.apache.spark.ml.param.Param)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <T> scala.Option<T> get(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param)</pre>
<div class="block">Optionally returns the value associated with a param.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="getOrElse(org.apache.spark.ml.param.Param,java.lang.Object)">
<!-- -->
</a><a name="getOrElse(org.apache.spark.ml.param.Param, T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrElse</h4>
<pre>public <T> T getOrElse(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param,
T default_)</pre>
<div class="block">Returns the value associated with a param or a default value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>default_</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="apply(org.apache.spark.ml.param.Param)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public <T> T apply(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param)</pre>
<div class="block">Gets the value of the input param or its default value if it does not exist.
Raises a NoSuchElementException if there is no value associated with the input param.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="contains(org.apache.spark.ml.param.Param)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><?> param)</pre>
<div class="block">Checks whether a parameter is explicitly specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="remove(org.apache.spark.ml.param.Param)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public <T> scala.Option<T> remove(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param)</pre>
<div class="block">Removes a key from this map and returns its value associated previously as an option.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="filter(org.apache.spark.ml.param.Params)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> filter(<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a> parent)</pre>
<div class="block">Filters this param map for the given parent.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="copy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> copy()</pre>
<div class="block">Creates a copy of this param map.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toSeq()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toSeq</h4>
<pre>public scala.collection.Seq<<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>> toSeq()</pre>
<div class="block">Converts this param map to a sequence of param pairs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Number of param pairs in this map.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</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="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/Param.html" title="class in org.apache.spark.ml.param"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/param/ParamMap.html" target="_top">Frames</a></li>
<li><a href="ParamMap.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>
|