All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.adapters.DoubleIterator

java.lang.Object
   |
   +----COM.objectspace.jgl.adapters.DoubleIterator

public final class DoubleIterator
extends Object
implements RandomAccessIterator, Serializable

A DoubleIterator is a random access iterator that allows you to iterate through the contents of a DoubleBuffer.

See Also:: RandomAccessIterator

DoubleIterator(): Construct myself to be an iterator with no associated data structure or position.
DoubleIterator(double[], int): Construct myself to be positioned at a particular index of a specific array of doubles.
DoubleIterator(DoubleArray, int): Construct myself to be positioned at a particular index of a specific DoubleArray.
DoubleIterator(DoubleBuffer, int): Construct myself to be positioned at a particular index of a specific DoubleBuffer.
DoubleIterator(DoubleIterator): Construct myself to be a copy of an existing iterator.

advance(): Advance by one.
advance(int): Advance by a specified amount.
atBegin(): Return true if I'm positioned at the first item of my input stream.
atEnd(): Return true if I'm positioned after the last item in my input stream.
begin(double[]): Return an iterator positioned at the first element of a particular array.
clone(): Return a clone of myself.
distance(ForwardIterator): Return the distance from myself to another iterator.
end(double[]): Return an iterator positioned immediately after the last element of a particular array.
equals(DoubleIterator): Return true if iterator is positioned at the same element as me.
equals(Object): Return true if a specified object is the same kind of iterator as me and is positioned at the same element.
get(): Return the object at my current position.
get(int): Return the object that is a specified distance from my current position.
getContainer(): Return my associated array.
getDouble()
getDouble(int)
hasMoreElements(): Return true if there are more elements in my input stream.
index(): Return my current index.
isCompatibleWith(InputIterator): Return true if both iterator and myself can be used as a range.
less(RandomAccessIterator): Return true if I'm before a specified iterator.
nextElement(): Return the next element in my input stream.
put(double)
put(int, double)
put(int, Object): Write an object at a specified distance from my current position.
put(Object): Set the object at my current position to a specified value.
retreat(): Retreat by one.
retreat(int): Retreat by a specified amount.

DoubleIterator

 public DoubleIterator()

Construct myself to be an iterator with no associated data structure or position.

DoubleIterator

 public DoubleIterator(DoubleIterator iterator)

Construct myself to be a copy of an existing iterator.

Parameters:: iterator - The iterator to copy.

DoubleIterator

 public DoubleIterator(double vector[],
                       int index)

Construct myself to be positioned at a particular index of a specific array of doubles.

Parameters:: vector - My associated double[].; index - My associated index.

DoubleIterator

 public DoubleIterator(DoubleArray vector,
                       int index)

Construct myself to be positioned at a particular index of a specific DoubleArray.

Parameters:: vector - My associated DoubleArray.; index - My associated index.

DoubleIterator

 public DoubleIterator(DoubleBuffer vector,
                       int index)

Construct myself to be positioned at a particular index of a specific DoubleBuffer.

Parameters:: vector - My associated DoubleBuffer.; index - My associated index.

begin

 public static DoubleIterator begin(double array[])

Return an iterator positioned at the first element of a particular array.

Parameters:: array - The array whose first element I will be positioned at.

end

 public static DoubleIterator end(double array[])

Return an iterator positioned immediately after the last element of a particular array.

Parameters:: array - The array whose last element I will be positioned after.

clone

 public Object clone()

Return a clone of myself.

Overrides:: clone in class Object

equals

 public boolean equals(Object object)

Return true if a specified object is the same kind of iterator as me and is positioned at the same element.

Parameters:: object - Any object.
Overrides:: equals in class Object

equals

 public boolean equals(DoubleIterator iterator)

Return true if iterator is positioned at the same element as me.

Parameters:: iterator - The iterator to compare myself against.

less

 public boolean less(RandomAccessIterator iterator)

Return true if I'm before a specified iterator.

Parameters:: iterator - The iterator to compare myself against.

atBegin

 public boolean atBegin()

Return true if I'm positioned at the first item of my input stream.

atEnd

 public boolean atEnd()

Return true if I'm positioned after the last item in my input stream.

hasMoreElements

 public boolean hasMoreElements()

Return true if there are more elements in my input stream.

advance

 public void advance()

Advance by one.

advance

 public void advance(int n)

Advance by a specified amount.

Parameters:: n - The amount to advance.

retreat

 public void retreat()

Retreat by one.

retreat

 public void retreat(int n)

Retreat by a specified amount.

Parameters:: n - The amount to retreat.

nextElement

 public Object nextElement()

Return the next element in my input stream.

Throws: NoSuchElementException: If I'm positioned at an invalid index.

get

 public Object get()

Return the object at my current position.

Throws: ArrayIndexOutOfBoundsException: If I'm positioned at an invalid index.

getDouble

 public double getDouble()

get

 public Object get(int offset)

Return the object that is a specified distance from my current position.

Parameters:: offset - The offset from my current position.
Throws: ArrayIndexOutOfBoundsException: If the adjusted index is invalid.

getDouble

 public double getDouble(int offset)

put

 public void put(Object object)

Set the object at my current position to a specified value.

Parameters:: object - The object to be written at my current position.
Throws: ArrayIndexOutOfBoundsException: If I'm positioned at an invalid index.

put

 public void put(double object)

put

 public void put(int offset,
                 Object object)

Write an object at a specified distance from my current position.

Parameters:: offset - The offset from my current position.; object - The object to write.
Throws: ArrayIndexOutOfBoundsException: If the adjusted index is invalid.

put

 public void put(int offset,
                 double object)

distance

 public int distance(ForwardIterator iterator)

Return the distance from myself to another iterator. I should be before the specified iterator.

Parameters:: iterator - The iterator to compare myself against.
Throws: IllegalArgumentException: If the iterators are incompatible.

index

 public int index()

Return my current index.

getContainer

 public Container getContainer()

Return my associated array.

isCompatibleWith

 public boolean isCompatibleWith(InputIterator iterator)

Return true if both iterator and myself can be used as a range.

All Packages  Class Hierarchy  This Package  Previous  Next  Index