trait Params extends Identifiable with Serializable
Trait for components that take parameters. This also provides an internal param map to store parameter values attached to the instance.
- Source
- params.scala
- Alphabetic
- By Inheritance
- Params
- Serializable
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
copy(extra: ParamMap): Params
Creates a copy of this instance with the same UID and some extra params.
Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See
defaultCopy()
. -
abstract
val
uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
- Definition Classes
- Identifiable
Concrete Value Members
-
final
def
clear(param: Param[_]): Params.this.type
Clears the user-supplied value for the input param.
-
def
explainParam(param: Param[_]): String
Explains a param.
Explains a param.
- param
input param, must belong to this instance.
- returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
-
def
explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See
explainParam()
. -
final
def
extractParamMap(): ParamMap
extractParamMap
with no extra values. -
final
def
extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
-
final
def
get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
-
final
def
getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
-
final
def
getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
-
def
getParam(paramName: String): Param[Any]
Gets a param by its name.
-
final
def
hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
-
def
hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
-
final
def
isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
-
final
def
isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
-
lazy val
params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
- Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
-
final
def
set[T](param: Param[T], value: T): Params.this.type
Sets a parameter in the embedded param map.
-
def
toString(): String
- Definition Classes
- Identifiable → AnyRef → Any