Class LongSequenceGenerator

Namespace

LfrlAnvil.Generators

Assembly

LfrlAnvil.Core.dll

Represents long sequence generator of values within specified range.

public class LongSequenceGenerator : SequenceGeneratorBase<long>, ISequenceGenerator<long>, IBoundGenerator<long>, IGenerator<long>, IGenerator

Inheritance

object

SequenceGeneratorBase<long>

LongSequenceGenerator

Implements

ISequenceGenerator<long>

IBoundGenerator<long>

IGenerator<long>

IGenerator

Inherited Members

SequenceGeneratorBase<long>.Bounds

SequenceGeneratorBase<long>.Step

SequenceGeneratorBase<long>.Reset(long)

SequenceGeneratorBase<long>.Generate()

SequenceGeneratorBase<long>.TryGenerate(out long)

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

LongSequenceGenerator()

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

public LongSequenceGenerator()

LongSequenceGenerator(Bounds<long>)

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

public LongSequenceGenerator(Bounds<long> bounds)

Parameters

bounds Bounds<long>

Range of values that can be generated.

LongSequenceGenerator(Bounds<long>, long, long)

Creates a new LongSequenceGenerator instance.

public LongSequenceGenerator(Bounds<long> bounds, long start, long step = 1)

Parameters

bounds Bounds<long>

Range of values that can be generated.

start long

Next value to generate.

step long

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.

LongSequenceGenerator(long, long)

Creates a new LongSequenceGenerator instance with greatest possible Bounds.

public LongSequenceGenerator(long start, long step = 1)

Parameters

start long

Next value to generate.

step long

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

Exceptions

ArgumentException

When step is equal to 0.

Methods

AddStep(long)

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

protected override sealed long AddStep(long value)

Parameters

value long

Previously generated value.

Returns

long

Next value to generate.

Exceptions

OverflowException

When an arithmetic overflow occurred.