ml.combust.bundle.dsl

Value

case class Value(bundleDataType: DataType, value: Any) extends Product with Serializable

This class is used to wrap Scala objects for later serialization into Bundle.ML

bundleDataType

data type of the value being stored

value

Scala object that will be serialized later

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Value
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Value(bundleDataType: DataType, value: Any)

    bundleDataType

    data type of the value being stored

    value

    Scala object that will be serialized later

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def asBundle(implicit hr: HasBundleRegistry): bundle.Value.Value

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. val bundleDataType: DataType

    data type of the value being stored

  9. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def getBoolean: Boolean

    Get value as a boolean.

    Get value as a boolean.

    returns

    boolean value

  13. def getBooleanList: Seq[Boolean]

    Get list of booleans.

    Get list of booleans.

    returns

    list of booleans

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

    Definition Classes
    AnyRef → Any
  15. def getCustom[T]: T

    Get value as a Scala object.

    Get value as a Scala object.

    T

    type of the custom value

    returns

    custom Scala object

  16. def getCustomList[T]: Seq[T]

    Get list of custom Scala objects.

    Get list of custom Scala objects.

    T

    data type of objects

    returns

    list of custom objects

  17. def getDouble: Double

    Get value as a double.

    Get value as a double.

    returns

    double value

  18. def getDoubleList: Seq[Double]

    Get list of doubles.

    Get list of doubles.

    returns

    list of doubles

  19. def getDoubleVector: Seq[Double]

    Get value as seq of doubles.

    Get value as seq of doubles.

    returns

    double tensor values

  20. def getListN: Seq[_]

    Get nested list of any type.

    Get nested list of any type.

    returns

    nested list of Scala objects

  21. def getLong: Long

    Get value as a long.

    Get value as a long.

    returns

    long value

  22. def getLongList: Seq[Long]

    Get list of longs.

    Get list of longs.

    returns

    list of longs

  23. def getString: String

    Get value as a string.

    Get value as a string.

    returns

    string value

  24. def getStringList: Seq[String]

    Get list of strings.

    Get list of strings.

    returns

    list of strings

  25. def getStringVector: Seq[String]

    Get value as seq of strings.

    Get value as seq of strings.

    returns

    string tensor values

  26. def getTensor[T]: Seq[T]

    Get value as a tensor.

    Get value as a tensor.

    T

    base type of tensor Double or String

    returns

    Scala seq of tensor values.

  27. def getTensorList[T]: Seq[Seq[T]]

    Get list of tensors.

    Get list of tensors.

    T

    Scala class of tensors Double or String

    returns

    list of tensors

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. def isLarge(implicit hr: HasBundleRegistry): Boolean

    Whether or not this value has a large serialization size.

    Whether or not this value has a large serialization size.

    This method is used in ml.combust.bundle.serializer.SerializationFormat.Mixed mode serialization to determine whether to serialize the value as JSON or as Protobuf.

    hr

    bundle registry needed for custom values

    returns

    true if the value has a large serialization size, false otherwise

  30. def isSmall(implicit hr: HasBundleRegistry): Boolean

    Whether or not this value has a small serialization size.

    Whether or not this value has a small serialization size.

    See isLarge for usage documentation. This method will always return the inverse of isLarge.

    hr

    bundle registry needed for custom values

    returns

    true if the value has a small serialization size, false otherwise

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

    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  35. val value: Any

    Scala object that will be serialized later

  36. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped