org.jblas.ranges
Class IndicesRange

java.lang.Object
  org.jblas.ranges.IndicesRange

All Implemented Interfaces:

Range

public class IndicesRange
extends java.lang.Object
implements Range

Range which varies over pre-specified indices. For example,

     int[] indices = new int[] { 1, 1, 2, 3, 5, 8, 13 };
     Range r = new IndicesRange(indices);

ranges over the first few Fibonacci numbers.

Constructor Summary

IndicesRange(DoubleMatrix is)
Initialize from DoubleMatrix.

IndicesRange(int[] is)
Initialize from integer array.

Method Summary

boolean	hasMore() More indices available?
int	index() Consecutive numbering of current index.
void	init(int l, int u) Initialize Range to available indices
int	length() Total number of indices.
void	next() Increase counter.
int	value() Get current index.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndicesRange

public IndicesRange(int[] is)

Initialize from integer array.

IndicesRange

public IndicesRange(DoubleMatrix is)

Initialize from DoubleMatrix. Entries are converted to integers by truncation.

Method Detail

init

public void init(int l,
                 int u)

Description copied from interface: Range

Initialize Range to available indices

Specified by:

init in interface Range

length

public int length()

Description copied from interface: Range

Total number of indices.

Specified by:

length in interface Range

next

public void next()

Description copied from interface: Range

Increase counter.

Specified by:

next in interface Range

index

public int index()

Description copied from interface: Range

Consecutive numbering of current index.

Specified by:

index in interface Range

value

public int value()

Description copied from interface: Range

Get current index.

Specified by:

value in interface Range

hasMore

public boolean hasMore()

Description copied from interface: Range

More indices available?

Specified by:

hasMore in interface Range