C# Class LibiadaCore.Misc.Iterators.IteratorSimpleStart

Iterator that goes from start of the chain and reading one element at a time.
Show file Open project: intervals-mining-lab/libiada-core Class Usage Examples

Protected Properties

Property Type Description
Length int
Source LibiadaCore.Core.AbstractChain
Step int

Public Methods

Method Description
Current ( ) : IBaseObject

Returns current value of iterator.
IteratorSimpleStart ( AbstractChain source, int step ) : System

Initializes a new instance of the IteratorSimpleStart class.
Next ( ) : bool

Moves iterator to the next position.
Reset ( ) : void

Returns iterator to the starting position. Before reading first value. IteratorBase.Next() method should be called.

Method Details

Current() public method

Returns current value of iterator.
/// Thrown if current position is invalid. ///
public Current ( ) : IBaseObject
return IBaseObject

IteratorSimpleStart() public method

Initializes a new instance of the IteratorSimpleStart class.
/// Thrown if one or more arguments are invalid. ///
public IteratorSimpleStart ( AbstractChain source, int step ) : System
source LibiadaCore.Core.AbstractChain /// Source chain. ///
step int /// Shift of iterator. ///
return System

Next() public method

Moves iterator to the next position.
public Next ( ) : bool
return bool

Reset() public method

Returns iterator to the starting position. Before reading first value. IteratorBase.Next() method should be called.
public Reset ( ) : void
return void

Property Details

Length protected property

Length of subsequence.
protected int Length
return int

Source protected property

Source chain.
protected AbstractChain,LibiadaCore.Core Source
return LibiadaCore.Core.AbstractChain

Step protected property

Shift of iterator.
protected int Step
return int