Class/Object

ml.combust.bundle.dsl

Value

Related Docs: object Value | package dsl

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    bundleDataType

    data type of the value being stored

    value

    Scala object that will be serialized later

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def asBundle(implicit hr: HasBundleRegistry): bundle.Value.Value

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val bundleDataType: DataType

    Permalink

    data type of the value being stored

  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

    Permalink

    Get value as a boolean.

    Get value as a boolean.

    returns

    boolean value

  11. def getBooleanList: Seq[Boolean]

    Permalink

    Get list of booleans.

    Get list of booleans.

    returns

    list of booleans

  12. def getByte: Byte

    Permalink

    Get value as a byte.

    Get value as a byte.

    returns

    byte value

  13. def getByteString: ByteString

    Permalink

    Get value as a byte string.

    Get value as a byte string.

    returns

    byte string

  14. def getByteStringList: Seq[ByteString]

    Permalink

    Get list of byte strings.

    Get list of byte strings.

    returns

    list of byte strings

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

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

    Permalink

    Get value as a Scala object.

    Get value as a Scala object.

    T

    type of the custom value

    returns

    custom Scala object

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

    Permalink

    Get list of custom Scala objects.

    Get list of custom Scala objects.

    T

    data type of objects

    returns

    list of custom objects

  18. def getDataType: DataType

    Permalink

    Get value as a data type.

    Get value as a data type.

    returns

    data type

  19. def getDataTypeList: Seq[DataType]

    Permalink

    Get list of data types.

    Get list of data types.

    returns

    list of data types

  20. def getDouble: Double

    Permalink

    Get value as a double.

    Get value as a double.

    returns

    double value

  21. def getDoubleList: Seq[Double]

    Permalink

    Get list of doubles.

    Get list of doubles.

    returns

    list of doubles

  22. def getFloat: Float

    Permalink

    Get value as a float.

    Get value as a float.

    returns

    float value

  23. def getInt: Int

    Permalink

    Get value as an int.

    Get value as an int.

    returns

    int value

  24. def getIntList: Seq[Int]

    Permalink

    Get list of ints.

    Get list of ints.

    returns

    list of ints

  25. def getListN: Seq[_]

    Permalink

    Get nested list of any type.

    Get nested list of any type.

    returns

    nested list of Scala objects

  26. def getLong: Long

    Permalink

    Get value as a long.

    Get value as a long.

    returns

    long value

  27. def getLongList: Seq[Long]

    Permalink

    Get list of longs.

    Get list of longs.

    returns

    list of longs

  28. def getShort: Short

    Permalink

    Get value as a short.

    Get value as a short.

    returns

    short value

  29. def getString: String

    Permalink

    Get value as a string.

    Get value as a string.

    returns

    string value

  30. def getStringList: Seq[String]

    Permalink

    Get list of strings.

    Get list of strings.

    returns

    list of strings

  31. def getStringVector: Seq[String]

    Permalink

    Get value as seq of strings.

    Get value as seq of strings.

    returns

    string tensor values

  32. def getTensor[T]: Tensor[T]

    Permalink

    Get value as a tensor.

    Get value as a tensor.

    T

    base type of tensor Double or String

    returns

    Scala seq of tensor values.

  33. def getTensorList[T]: Seq[Tensor[T]]

    Permalink

    Get list of tensors.

    Get list of tensors.

    T

    Scala class of tensors Double or String

    returns

    list of tensors

  34. final def isInstanceOf[T0]: Boolean

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

    Permalink

    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

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

    Permalink

    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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  41. val value: Any

    Permalink

    Scala object that will be serialized later

  42. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped