Package org.drip.spaces.iterator

Class SequenceIndexIterator

java.lang.Object
org.drip.spaces.iterator.SequenceIndexIterator
public class SequenceIndexIterator
extends java.lang.Object
SequenceIndexIterator contains the Functionality to iterate through a List of Sequence Indexes. It provides the following Functionality:
  • Create a Standard Sequence/Index Iterator
  • SequenceIndexIterator Constructor
  • Retrieve the First Cursor
  • Retrieve the Next Cursor
  • Retrieve the Size of the Iterator

Module Computational Core Module
Library Statistical Learning Library
Project R1 and Rd Vector/Tensor Spaces (Validated and/or Normed), and Function Classes
Package Iterative/Exhaustive Vector Space Scanners
Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    SequenceIndexIterator​(int[] maximumEntriesPerIndexArray, boolean cycle)
    SequenceIndexIterator Constructor

  • Method Summary

    Modifier and Type Method Description
    int[] first()
    Retrieve the First Cursor
    int[] next()
    Retrieve the Next Cursor
    int size()
    Retrieve the Size of the Iterator
    static SequenceIndexIterator Standard​(int sequenceCount, int indexPerVariableSequence)
    Create a Standard Sequence/Index Iterator

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SequenceIndexIterator

      public SequenceIndexIterator​(int[] maximumEntriesPerIndexArray, boolean cycle) throws java.lang.Exception
      SequenceIndexIterator Constructor
      Parameters:
      maximumEntriesPerIndexArray - Maximum Entries per Index
      cycle - TRUE - Cycle around the Index Entries
      Throws:
      java.lang.Exception - Thrown if Inputs are invalid

  • Method Details

    • Standard

      public static final SequenceIndexIterator Standard​(int sequenceCount, int indexPerVariableSequence)
      Create a Standard Sequence/Index Iterator
      Parameters:
      sequenceCount - Number Variable Sequences
      indexPerVariableSequence - Number of Indexes per Variable Sequence
      Returns:
      The Sequence/Index Iterator Instance

    • first

      public int[] first()
      Retrieve the First Cursor
      Returns:
      The First Cursor

    • next

      public int[] next()
      Retrieve the Next Cursor
      Returns:
      The Next Cursor

    • size

      public int size()
      Retrieve the Size of the Iterator
      Returns:
      Size of the Iterator