C# Class LibiadaCore.Misc.Iterators.IteratorBase

Abstract chain iterator.
Inheritance: IIterator
Show file Open project: intervals-mining-lab/libiada-core

Protected Properties

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

Public Methods

Method Description
Current ( ) : AbstractChain

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

Initializes a new instance of the IteratorBase 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 ( ) : AbstractChain
return LibiadaCore.Core.AbstractChain

IteratorBase() public method

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

Next() public abstract method

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

Reset() public abstract method

Returns iterator to the starting position. Before reading first value. IteratorBase.Next() method should be called.
public abstract 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