Package ai.djl.ndarray.index.dim

Class NDIndexBooleans

  • All Implemented Interfaces:
    NDIndexElement
    public class NDIndexBooleans
extends java.lang.Object
implements NDIndexElement
    An NDIndexElement to return values based on a mask binary NDArray.

    • Constructor Summary

      Constructors 
      Constructor Description
      NDIndexBooleans​(NDArray index)
      Constructs a NDIndexBooleans instance with specified mask binary NDArray.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      NDArray getIndex()
      Returns the mask binary NDArray.
      int getRank()
      Returns the number of dimensions occupied by this index element.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • NDIndexBooleans

        public NDIndexBooleans​(NDArray index)
        Constructs a NDIndexBooleans instance with specified mask binary NDArray.
        Parameters:
        index - the mask binary NDArray

    • Method Detail

      • getIndex

        public NDArray getIndex()
        Returns the mask binary NDArray.
        Returns:
        the mask binary NDArray

      • getRank

        public int getRank()
        Returns the number of dimensions occupied by this index element.
        Specified by:
        getRank in interface NDIndexElement
        Returns:
        the number of dimensions occupied by this index element