org.hava.engine
Interface HIterator

public interface HIterator

A native (Java) iterator that may be invoked from Hava source. Several iterators are predefined in Hava, and others may be registered with the Engine. An external registered iterator must implement this interface.

Nested Class Summary

static interface

HIterator.HIteratorInstance Performs the calculations associated with a particular HIterator.

Method Summary

HIterator.HIteratorInstance	createInstance() Returns a fresh instance of this iterator.
java.lang.String	getIdentifier() Returns the name of this function as it would appear in a Hava invocation, for example, "median".
boolean	requiresIndex() Returns true if this iterator uses an index value (for example, argmax or argmin).

Method Detail

createInstance

HIterator.HIteratorInstance createInstance()

Returns a fresh instance of this iterator.

getIdentifier

java.lang.String getIdentifier()

Returns the name of this function as it would appear in a Hava invocation, for example, "median".

requiresIndex

boolean requiresIndex()

Returns true if this iterator uses an index value (for example, argmax or argmin). In this case, chained directives are not permitted.