org.apache.mxnet

NDArray

Related Docs: object NDArray | package mxnet

class NDArray extends NativeResource

NDArray object in mxnet. NDArray is basic ndarray/Tensor like data structure in mxnet.
NOTE: NDArray is stored in native memory. Use NDArray in a try-with-resources() construct or a [[org.apache.mxnet.ResourceScope]] in a try-with-resource to have them automatically disposed. You can explicitly control the lifetime of NDArray by calling dispose manually. Failure to do this will result in leaking native memory.

Linear Supertypes
NativeResource, WarnIfNotDisposed, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NDArray
  2. NativeResource
  3. WarnIfNotDisposed
  4. AutoCloseable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

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

    Definition Classes
    AnyRef → Any
  3. def %(other: MX_PRIMITIVE_TYPE): NDArray

  4. def %(other: NDArray): NDArray

  5. def %=(other: MX_PRIMITIVE_TYPE): NDArray

  6. def %=(other: NDArray): NDArray

  7. def *(other: MX_PRIMITIVE_TYPE): NDArray

  8. def *(other: NDArray): NDArray

  9. def **(other: MX_PRIMITIVE_TYPE): NDArray

  10. def **(other: NDArray): NDArray

  11. def **=(other: MX_PRIMITIVE_TYPE): NDArray

  12. def **=(other: NDArray): NDArray

  13. def *=(other: MX_PRIMITIVE_TYPE): NDArray

  14. def *=(other: NDArray): NDArray

  15. def +(other: MX_PRIMITIVE_TYPE): NDArray

  16. def +(other: NDArray): NDArray

  17. def +=(other: MX_PRIMITIVE_TYPE): NDArray

  18. def +=(other: NDArray): NDArray

  19. def -(other: MX_PRIMITIVE_TYPE): NDArray

  20. def -(other: NDArray): NDArray

  21. def -=(other: MX_PRIMITIVE_TYPE): NDArray

  22. def -=(other: NDArray): NDArray

  23. def /(other: MX_PRIMITIVE_TYPE): NDArray

  24. def /(other: NDArray): NDArray

  25. def /=(other: MX_PRIMITIVE_TYPE): NDArray

  26. def /=(other: NDArray): NDArray

  27. def <(other: MX_PRIMITIVE_TYPE): NDArray

  28. def <(other: NDArray): NDArray

  29. def <=(other: MX_PRIMITIVE_TYPE): NDArray

  30. def <=(other: NDArray): NDArray

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

    Definition Classes
    AnyRef → Any
  32. def >(other: MX_PRIMITIVE_TYPE): NDArray

  33. def >(other: NDArray): NDArray

  34. def >=(other: MX_PRIMITIVE_TYPE): NDArray

  35. def >=(other: NDArray): NDArray

  36. def T: NDArray

  37. def asInContext(context: Context): NDArray

    Return an NDArray that lives in the target context.

    Return an NDArray that lives in the target context. If the array is already in that context, self is returned. Otherwise, a copy is made.

    context

    The target context we want the return value to live in.

    returns

    A copy or self as an NDArray that lives in the target context.

  38. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  39. def asType(dtype: DType.DType): NDArray

    Return a copied numpy array of current array with specified type.

    Return a copied numpy array of current array with specified type.

    dtype

    Desired type of result array.

    returns

    A copy of array content.

  40. def at(idx: Int): NDArray

    Return a sub NDArray that shares memory with current one.

    Return a sub NDArray that shares memory with current one. the first axis will be rolled up, which causes its shape different from slice(i, i+1)

    idx

    index of sub array.

  41. val bytesAllocated: Long

    Off-Heap Bytes Allocated for this object

    Off-Heap Bytes Allocated for this object

    Definition Classes
    NDArray → NativeResource
  42. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def close(): Unit

    Definition Classes
    NativeResource → AutoCloseable
  44. def context: Context

    Get context of current NDArray.

    Get context of current NDArray.

    returns

    The context of current NDArray.

  45. def copy(): NDArray

    Clone the current array

    Clone the current array

    returns

    the copied NDArray in the same context

  46. def copyTo(ctx: Context): NDArray

    Copy the content of current array to a new NDArray in the context.

    Copy the content of current array to a new NDArray in the context.

    ctx

    Target context we want to copy data to.

    returns

    The copy target NDArray

  47. def copyTo(other: NDArray): NDArray

    Copy the content of current array to other.

    Copy the content of current array to other.

    other

    Target NDArray or context we want to copy data to.

    returns

    The copy target NDArray

  48. val creationTrace: Option[Array[StackTraceElement]]

    Attributes
    protected
    Definition Classes
    WarnIfNotDisposed
  49. def dispose(): Unit

    Release the native memory.

    Release the native memory.
    The NDArrays it depends on will NOT be disposed.
    The object shall never be used after it is disposed.

    Definition Classes
    NDArray → NativeResource
  50. def disposeDeps(): NDArray

    Dispose all NDArrays who help to construct this array.

    Dispose all NDArrays who help to construct this array.
    e.g. (a * b + c).disposeDeps() will dispose a, b, c (including their deps) and a * b

    returns

    this NDArray

  51. def disposeDepsExcept(arrs: NDArray*): NDArray

    Dispose all NDArrays who help to construct this array, excepts those in the arguments.

    Dispose all NDArrays who help to construct this array, excepts those in the arguments.
    e.g. (a * b + c).disposeDepsExcept(a, b) will dispose c and a * b. Note that a, b's dependencies will not be disposed either.

    arrs

    array of NDArrays

    returns

    this array

  52. def dtype: DType.DType

    Get data type of current NDArray.

    Get data type of current NDArray.

    returns

    class representing type of current ndarray

  53. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  54. def equals(o: Any): Boolean

    Definition Classes
    NDArray → AnyRef → Any
  55. def finalize(): Unit

    Attributes
    protected
    Definition Classes
    WarnIfNotDisposed → AnyRef
  56. final def getClass(): Class[_]

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

    Definition Classes
    NDArray → AnyRef → Any
  58. def internal: NDArrayInternal

  59. def isDisposed: Boolean

    Definition Classes
    NativeResource → WarnIfNotDisposed
  60. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  61. def logDisposeWarning(): Unit

    Attributes
    protected
    Definition Classes
    WarnIfNotDisposed
  62. def nativeAddress: CPtrAddress

    native Address associated with this object

    native Address associated with this object

    Definition Classes
    NDArray → NativeResource
  63. def nativeDeAllocator: (CPtrAddress) ⇒ Int

    Function Pointer to the NativeDeAllocator of nativeAddress

    Function Pointer to the NativeDeAllocator of nativeAddress

    Definition Classes
    NDArray → NativeResource
  64. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  67. val ref: NativeResourceRef

    Call NativeResource.register to get the reference

    Call NativeResource.register to get the reference

    Definition Classes
    NDArray → NativeResource
  68. def register(): NativeResourceRef

    Register this object for PhantomReference tracking and in ResourceScope if used inside ResourceScope.

    Register this object for PhantomReference tracking and in ResourceScope if used inside ResourceScope.

    returns

    NativeResourceRef that tracks reachability of this object using PhantomReference

    Definition Classes
    NativeResource
  69. def reshape(dims: Shape): NDArray

    Return a reshaped NDArray that shares memory with current one.

    Return a reshaped NDArray that shares memory with current one.

    dims

    New shape.

    returns

    a reshaped NDArray that shares memory with current one.

  70. def reshape(dims: Array[Long], reverse: Option[Boolean] = None): NDArray

    Return a reshaped NDArray that shares memory with current one.

    Return a reshaped NDArray that shares memory with current one.

    dims

    New shape.

    reverse

    whether to inplace reshape

    returns

    a reshaped NDArray that shares memory with current one.

  71. def reshape(dims: Array[Int]): NDArray

    Return a reshaped NDArray that shares memory with current one.

    Return a reshaped NDArray that shares memory with current one.

    dims

    New shape.

    returns

    a reshaped NDArray that shares memory with current one.

  72. def serialize(): Array[Byte]

  73. def set(other: Array[Double]): NDArray

  74. def set(other: Array[Float]): NDArray

  75. def set(other: NDArray): NDArray

  76. def set(value: MX_PRIMITIVE_TYPE): NDArray

    Set the values of the NDArray

    Set the values of the NDArray

    value

    Value to set

    returns

    Current NDArray

  77. def shape: Shape

    Get shape of current NDArray.

    Get shape of current NDArray.

    returns

    an array representing shape of current ndarray

  78. def size: Int

  79. def slice(i: Int): NDArray

    Return a sliced NDArray at the ith position of axis0

    Return a sliced NDArray at the ith position of axis0

    i
    returns

    a sliced NDArray that shares memory with current one.

  80. def slice(range: (Int, Int)): NDArray

  81. def slice(start: Int, stop: Int): NDArray

    Return a sliced NDArray that shares memory with current one.

    Return a sliced NDArray that shares memory with current one. NDArray only support continuous slicing on axis 0

    start

    Starting index of slice.

    stop

    Finishing index of slice.

    returns

    a sliced NDArray that shares memory with current one.

  82. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  83. def toArray: Array[Float]

    Return a copied flat java array of current array (row-major).

    Return a copied flat java array of current array (row-major).

    returns

    A copy of array content.

  84. def toFloat64Array: Array[Double]

    Return a copied flat java array of current array (row-major) with datatype as Float64/Double.

    Return a copied flat java array of current array (row-major) with datatype as Float64/Double.

    returns

    A copy of array content.

  85. def toFloat64Scalar: Double

  86. def toScalar: Float

    Return a CPU scalar(float) of current ndarray.

    Return a CPU scalar(float) of current ndarray. This ndarray must have shape (1,)

    returns

    The scalar representation of the ndarray.

  87. def toString(): String

    Visualize the internal structure of NDArray

    Visualize the internal structure of NDArray

    returns

    String that show the structure

    Definition Classes
    NDArray → AnyRef → Any
  88. def tracingEnabled: Boolean

    Attributes
    protected
    Definition Classes
    WarnIfNotDisposed
  89. def unary_-(): NDArray

  90. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. def waitToRead(): Unit

    Block until all pending writes operations on current NDArray are finished.

    Block until all pending writes operations on current NDArray are finished. This function will return when all the pending writes to the current NDArray finishes. There can still be pending read going on when the function returns.

  94. val writable: Boolean

Inherited from NativeResource

Inherited from WarnIfNotDisposed

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped