Class IntSequenceGenerator

Namespace

LfrlAnvil.Generators

Assembly

LfrlAnvil.Core.dll

Represents int sequence generator of values within specified range.

public class IntSequenceGenerator : SequenceGeneratorBase<int>, ISequenceGenerator<int>, IBoundGenerator<int>, IGenerator<int>, IGenerator

Inheritance

object

SequenceGeneratorBase<int>

IntSequenceGenerator

Implements

ISequenceGenerator<int>

IBoundGenerator<int>

IGenerator<int>

IGenerator

Inherited Members

SequenceGeneratorBase<int>.Bounds

SequenceGeneratorBase<int>.Step

SequenceGeneratorBase<int>.Reset(int)

SequenceGeneratorBase<int>.Generate()

SequenceGeneratorBase<int>.TryGenerate(out int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

GeneratorExtensions.ToEnumerable(IGenerator)

GeneratorExtensions.ToEnumerable<T>(IGenerator<T>)

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T?, Func<T, T?>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T?, Func<T, T?>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Constructors

IntSequenceGenerator()

Creates a new IntSequenceGenerator instance that starts with 0, with Step equal to 1 and with greatest possible Bounds.

public IntSequenceGenerator()

IntSequenceGenerator(Bounds<int>)

Creates a new IntSequenceGenerator instance that starts with minimum possible value defined by bounds, with Step equal to 1.

public IntSequenceGenerator(Bounds<int> bounds)

Parameters

bounds Bounds<int>

Range of values that can be generated.

IntSequenceGenerator(Bounds<int>, int, int)

Creates a new IntSequenceGenerator instance.

public IntSequenceGenerator(Bounds<int> bounds, int start, int step = 1)

Parameters

bounds Bounds<int>

Range of values that can be generated.

start int

Next value to generate.

step int

Difference between two consecutively generated values. Equal to 1 by default.

Exceptions

ArgumentOutOfRangeException

When bounds do not contain start.

ArgumentException

When step is equal to 0.

IntSequenceGenerator(int, int)

Creates a new IntSequenceGenerator instance with greatest possible Bounds.

public IntSequenceGenerator(int start, int step = 1)

Parameters

start int

Next value to generate.

step int

Difference between two consecutively generated values. Equal to 1 by default.

Exceptions

ArgumentException

When step is equal to 0.

Methods

AddStep(int)

Adds Step to the previously generated value in order to calculate the next value to generate.

protected override sealed int AddStep(int value)

Parameters

value int

Previously generated value.

Returns

int

Next value to generate.

Exceptions

OverflowException

When an arithmetic overflow occurred.