Package ai.djl.ndarray.index.dim

Class NDIndexSlice

  • All Implemented Interfaces:
    NDIndexElement
    public class NDIndexSlice
extends java.lang.Object
implements NDIndexElement
    An NDIndexElement that returns a range of values in the specified dimension.

    • Constructor Summary

      Constructors 
      Constructor Description
      NDIndexSlice​(java.lang.Long min, java.lang.Long max, java.lang.Long step)
      Constructs a NDIndexSlice instance with specified range and step.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Long getMax()
      Returns the end of the range.
      java.lang.Long getMin()
      Returns the start of the range.
      int getRank()
      Returns the number of dimensions occupied by this index element.
      java.lang.Long getStep()
      Returns the step between each slice.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • NDIndexSlice

        public NDIndexSlice​(java.lang.Long min,
                    java.lang.Long max,
                    java.lang.Long step)
        Constructs a NDIndexSlice instance with specified range and step.
        Parameters:
        min - the start of the range
        max - the end of the range
        step - the step between each slice
        Throws:
        java.lang.IllegalArgumentException - Thrown if the step is zero

    • Method Detail

      • getMin

        public java.lang.Long getMin()
        Returns the start of the range.
        Returns:
        the start of the range

      • getMax

        public java.lang.Long getMax()
        Returns the end of the range.
        Returns:
        the end of the range

      • getStep

        public java.lang.Long getStep()
        Returns the step between each slice.
        Returns:
        the step between each slice

      • 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