Class/Object

org.apache.flink.ml.common

ParameterMap

Related Docs: object ParameterMap | package common

Permalink

class ParameterMap extends Serializable

Map used to store configuration parameters for algorithms. The parameter values are stored in a Map being identified by a Parameter object. ParameterMaps can be fused. This operation is left associative, meaning that latter ParameterMaps can override parameter values defined in a preceding ParameterMap.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParameterMap
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParameterMap()

    Permalink
  2. new ParameterMap(map: Map[Parameter[_], Any])

    Permalink

    map

    Map containing parameter settings

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(parameters: ParameterMap): ParameterMap

    Permalink

    Adds the parameter values contained in parameters to itself.

    Adds the parameter values contained in parameters to itself.

    parameters

    ParameterMap containing the parameter values to be added

    returns

    this after inserting the parameter values from parameters

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def add[T](parameter: Parameter[T], value: T): ParameterMap

    Permalink

    Adds a new parameter value to the ParameterMap.

    Adds a new parameter value to the ParameterMap.

    T

    Type of value

    parameter

    Key

    value

    Value associated with the given key

  6. def apply[T](parameter: Parameter[T]): T

    Permalink

    Retrieves a parameter value associated to a given key.

    Retrieves a parameter value associated to a given key. If there is no value contained in the map, then the default value of the Parameter is checked. If the default value is defined, then it is returned. If the default is undefined, then a NoSuchElementException is thrown.

    T

    Type of value

    parameter

    Key

    returns

    Value associated with the given key or its default value

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def get[T](parameter: Parameter[T]): Option[T]

    Permalink

    Retrieves a parameter value associated to a given key.

    Retrieves a parameter value associated to a given key. The value is returned as an Option. If there is no value associated to the given key, then the default value of the Parameter is returned.

    T

    Type of the value to retrieve

    parameter

    Key

    returns

    Some(value) if an value is associated to the given key, otherwise the default value defined by parameter

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. val map: Map[Parameter[_], Any]

    Permalink

    Map containing parameter settings

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped