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.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
SequenceIndexIterator(int[] aiMax, boolean bCycle) IndexIterator Constructor

Method Summary

Modifier and Type	Method and 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 iNumSequence, int iNumIndex) Create a Standard Sequence/Index Iterator

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceIndexIterator

public SequenceIndexIterator(int[] aiMax,
                             boolean bCycle)
                      throws java.lang.Exception

IndexIterator Constructor

Parameters:

aiMax - Maximum Entries per Index

bCycle - TRUE - Cycle around the Index Entries

Throws:

java.lang.Exception - Thrown if Inputs are incalid

Method Detail

Standard

public static final SequenceIndexIterator Standard(int iNumSequence,
                                                   int iNumIndex)

Create a Standard Sequence/Index Iterator

Parameters:

iNumSequence - Number Variable Sequences

iNumIndex - 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