Package jep

Class NDArray<T>


  • public class NDArray<T>
    extends java.lang.Object

    Represents a numpy.ndarray in Java. If Jep was compiled with numpy support, this object will not be wrapped as a PyJobject in the Python sub-interpreter(s), it will instead be transformed into a numpy.ndarray automatically (and vice versa). The transformation in either direction occurs with a memcpy, therefore changes in the array in one language will not affect the array in the other language.

    NDArrays only support Java primitive arrays as the underlying type of data. The data can conceptually be multi-dimensional, but it must be represented as a one-dimensional array in Java to ensure the memory is contiguous.

    Since:
    3.3
    • Constructor Summary

      Constructors 
      Constructor Description
      NDArray​(T data)
      Constructor for a Java NDArray.
      NDArray​(T data, boolean unsigned)
      Constructor for a Java NDArray.
      NDArray​(T data, boolean unsigned, int... dimensions)
      Constructor for a Java NDArray.
      NDArray​(T data, int... dimensions)
      Constructor for a Java NDArray.
    • Constructor Detail

      • NDArray

        public NDArray​(T data)
        Constructor for a Java NDArray. Presumes the data is one dimensional.
        Parameters:
        data - a one-dimensional primitive array such as float[], int[]
      • NDArray

        public NDArray​(T data,
                       boolean unsigned)
        Constructor for a Java NDArray. Presumes the data is one dimensional.
        Parameters:
        data - a one-dimensional primitive array such as float[], int[]
        unsigned - whether the data is to be interpreted as unsigned
      • NDArray

        public NDArray​(T data,
                       int... dimensions)
        Constructor for a Java NDArray.
        Parameters:
        data - a one-dimensional primitive array such as float[], int[]
        dimensions - the conceptual dimensions of the data (corresponds to the numpy.ndarray dimensions in C-contiguous order)
      • NDArray

        public NDArray​(T data,
                       boolean unsigned,
                       int... dimensions)
        Constructor for a Java NDArray.
        Parameters:
        data - a one-dimensional primitive array such as float[], int[]
        unsigned - whether the data is to be interpreted as unsigned
        dimensions - the conceptual dimensions of the data (corresponds to the numpy.ndarray dimensions in C-contiguous order)
    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • getDimensions

        public int[] getDimensions()
      • isUnsigned

        public boolean isUnsigned()
      • getData

        public T getData()