org.jmlspecs.jmlunit.strategies
Class IntArrayIterator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.IntAbstractIterator
      org.jmlspecs.jmlunit.strategies.IntArrayIterator

All Implemented Interfaces:

Cloneable, IndefiniteIterator, IntIterator

public class IntArrayIterator

extends IntAbstractIterator

A IntIterator over arrays of int elements.

Author:

Gary T. Leavens

Class Specifications

public invariant 0 <= this.next&&this.next <= this.elems.length;

Specifications inherited from class Object

represents objectState <- org.jmlspecs.lang.JMLDataGroup.IT; public represents _getClass <- \typeof(this);

Model Field Summary

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Field Summary
[spec_public] private  int[]	elems           The elements
[spec_public] private  int	next           The next element's index (zero based)

 

Constructor Summary
protected	IntArrayIterator(int next, non_null int[] elems)           Initialize this iterator to iterate over a clone of the array, starting at the given next index
	IntArrayIterator(non_null int[] elems)           Initialize this iterator to iterate over a clone of the array

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
void	advance()           Advance the state of this iteration to the next position.
boolean	atEnd()           Is this iterator at its end?
Object	clone()           Return a copy of this iterator in the same state as this object.
int	getInt()           Return the current int in this iterator.
String	toString()

 

Methods inherited from class org.jmlspecs.jmlunit.strategies.IntAbstractIterator

get

 

Methods inherited from class java.lang.Object

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

 

Field Detail

next

private int next

The next element's index (zero based)

Specifications: spec_public
is in groups: objectState

elems

private int[] elems

The elements

Specifications: spec_public non_null

IntArrayIterator

public IntArrayIterator(non_null int[] elems)

Initialize this iterator to iterate over a clone of the array

Specifications:

public normal_behavior
assignable this.elems, next;
ensures this.next == 0&&java.util.Arrays.equals(elems,this.elems);

IntArrayIterator

protected IntArrayIterator(int next,
                           non_null int[] elems)

Initialize this iterator to iterate over a clone of the array, starting at the given next index

Specifications:

protected normal_behavior
requires 0 <= next&&next <= elems.length;
assignable this.elems, this.next;
ensures this.next == next&&java.util.Arrays.equals(elems,this.elems);

atEnd

public boolean atEnd()

Description copied from interface: IndefiniteIterator

Is this iterator at its end? That is, if we called get(), would it throw an exception?

Specifications: pure

     also

public normal_behavior
ensures \result <==> !(this.next < this.elems.length);

    implies_that

public normal_behavior
ensures !\result <==> this.next == this.elems.length;

Specifications inherited from overridden method in interface IndefiniteIterator:
       pure

getInt

public int getInt()

Description copied from interface: IntIterator

Return the current int in this iterator.

Specifications: pure

     also

public normal_behavior
requires this.next < this.elems.length;
assignable \nothing;
ensures new java.lang.Integer(\result ).equals(new java.lang.Integer(this.elems[this.next]));

     also

public exceptional_behavior
requires this.next >= this.elems.length;
assignable \nothing;
signals_only java.util.NoSuchElementException;

    implies_that

public behavior
assignable \nothing;
signals_only java.util.NoSuchElementException;
signals (java.util.NoSuchElementException e) this.atEnd();

Specifications inherited from overridden method in interface IntIterator:
       pure

public behavior
assignable \nothing;
ensures_redundantly this.atEnd() == \old(this.atEnd());
signals_only java.util.NoSuchElementException;
signals (java.util.NoSuchElementException) \old(this.atEnd());

advance

public void advance()

Description copied from interface: IndefiniteIterator

Advance the state of this iteration to the next position. Note that this never throws an exception.

Specifications:

     also

public normal_behavior
requires this.next < this.elems.length;
assignable next;
ensures this.next == \old(this.next+1);

     also

public normal_behavior
requires this.next == this.elems.length;
assignable \nothing;

Specifications inherited from overridden method in interface IndefiniteIterator:

public normal_behavior
assignable objectState;

clone

public Object clone()

Description copied from interface: IntIterator

Return a copy of this iterator in the same state as this object.

Specified by:

clone in interface IntIterator

Overrides:

clone in class IntAbstractIterator

Specifications: non_null (inherited)pure

Specifications inherited from overridden method in class IntAbstractIterator:
       pure

Specifications inherited from overridden method in class Object:
       non_null

protected normal_behavior
requires this instanceof java.lang.Cloneable;
assignable \nothing;
ensures \result != null;
ensures \typeof(\result ) == \typeof(this);
ensures (* \result is a clone of this *);

     also

protected normal_behavior
requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures java.lang.reflect.Array.getLength(\result ) == java.lang.reflect.Array.getLength(this);
ensures ( \forall int i; 0 <= i&&i < java.lang.reflect.Array.getLength(this); ( \exists java.lang.Object result_i; result_i == java.lang.reflect.Array.get(\result ,i); (result_i == null&&java.lang.reflect.Array.get(this,i) == null)||(result_i != null&&result_i.equals(java.lang.reflect.Array.get(this,i)))));

     also

protected exceptional_behavior
requires !(this instanceof java.lang.Cloneable);
assignable \nothing;
signals_only java.lang.CloneNotSupportedException;

     also

protected normal_behavior
requires \elemtype(\typeof(this)) <: \type(java.lang.Object);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(int);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((int[])\result ).length == ((int[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((int[])this).length; ((int[])\result )[i] == ((int[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(byte);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((byte[])\result ).length == ((byte[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((byte[])this).length; ((byte[])\result )[i] == ((byte[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(char);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((char[])\result ).length == ((char[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((char[])this).length; ((char[])\result )[i] == ((char[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(long);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((long[])\result ).length == ((long[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((long[])this).length; ((long[])\result )[i] == ((long[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(short);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((short[])\result ).length == ((short[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((short[])this).length; ((short[])\result )[i] == ((short[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(boolean);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((boolean[])\result ).length == ((boolean[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((boolean[])this).length; ((boolean[])\result )[i] == ((boolean[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(float);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((float[])\result ).length == ((float[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((float[])this).length; (java.lang.Float.isNaN(((float[])\result )[i])&&java.lang.Float.isNaN(((float[])this)[i]))||((float[])\result )[i] == ((float[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(double);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((double[])\result ).length == ((double[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((double[])this).length; (java.lang.Double.isNaN(((double[])\result )[i])&&java.lang.Double.isNaN(((double[])this)[i]))||((double[])\result )[i] == ((double[])this)[i]);

Specifications inherited from overridden method in interface IntIterator:
       pure

     also

public normal_behavior
assignable \nothing;
ensures \fresh(\result )&&\result instanceof org.jmlspecs.jmlunit.strategies.IntIterator;
ensures \result != this;
ensures_redundantly \result != null;
ensures ((org.jmlspecs.jmlunit.strategies.IntIterator)\result ).atEnd() == this.atEnd();
ensures !this.atEnd() ==> new java.lang.Integer(((org.jmlspecs.jmlunit.strategies.IntIterator)\result ).getInt()).equals(new java.lang.Integer(this.getInt()));

Specifications inherited from overridden method in interface IndefiniteIterator:
       pure

     also

public normal_behavior
assignable \nothing;
ensures \fresh(\result )&&\result instanceof org.jmlspecs.jmlunit.strategies.IndefiniteIterator;
ensures \result != this;
ensures_redundantly \result != null;
ensures ((org.jmlspecs.jmlunit.strategies.IndefiniteIterator)\result ).atEnd() == this.atEnd();

toString

public String toString()

Overrides:

toString in class Object

Specifications: non_null

Specifications inherited from overridden method in class Object:
       non_null

public normal_behavior
assignable objectState;
ensures \result != null&&\result .equals(this.theString);
ensures (* \result is a string representation of this object *);

     also

public code normal_behavior
assignable \nothing;
ensures \result != null&&(* \result is the instance's class name, followed by an @, followed by the instance's hashcode in hex *);

     also

public code model_program { ... }

    implies_that

assignable objectState;
ensures \result != null;