MaximumLengthSequence (FsODE)

FsODE

Documentation for 0.0.2

MaximumLengthSequence Type

Namespace: Altaxo.Calc.Probability
Assembly: AltaxoCore.Redist.dll
Base Type: obj

Represents a maximum length sequence (MLS). Those sequences have a repeat length of 2^k-1, with k being an integer value (k=2..64). This class allows the generation of sequences with a length of 2^2-1 up to 2^64-1.

Instance members

Instance member	Description
`this.GetInfiniteSequence` Full Usage: `this.GetInfiniteSequence` Parameters: logicalZero : `'T` - The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` - The value that is returned if the value of the binary sequence is logical one. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.	Gets the sequence. The enumeration never stops, thus you are resonsible for stopping it. The values are repeated after n values, where n is the MaximumLengthSequence.Length. logicalZero : `'T` The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` The value that is returned if the value of the binary sequence is logical one. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.
`this.GetInfiniteSequence` Full Usage: `this.GetInfiniteSequence` Parameters: logicalZero : `'T` - The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` - The value that is returned if the value of the binary sequence is logical one. startValue : `uint64` - The initial value of the sequence. Normally, this value is initialized with the value of the sequence length. Here you can provide any other value that is non-zero when and-ing it with the sequence length. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.	Gets the sequence. The enumeration never stops, thus you are resonsible for stopping it. The values are repeated after n values, where n is the MaximumLengthSequence.Length. logicalZero : `'T` The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` The value that is returned if the value of the binary sequence is logical one. startValue : `uint64` The initial value of the sequence. Normally, this value is initialized with the value of the sequence length. Here you can provide any other value that is non-zero when and-ing it with the sequence length. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.
`this.GetSequence` Full Usage: `this.GetSequence` Parameters: logicalZero : `'T` - The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` - The value that is returned if the value of the binary sequence is logical one. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.	Gets the sequence. The enumeration stops after yielding n values, with n being the sequence length. logicalZero : `'T` The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` The value that is returned if the value of the binary sequence is logical one. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.
`this.GetSequence` Full Usage: `this.GetSequence` Parameters: logicalZero : `'T` - The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` - The value that is returned if the value of the binary sequence is logical one. startValue : `uint64` - The initial value of the sequence. Normally, this value is initialized with the value of the sequence length. Here you can provide any other value that is non-zero when and-ing it with the sequence length. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.	Gets the sequence. The enumeration stops after yielding n values, with n being the sequence length. logicalZero : `'T` The value that is returned if the value of the binary sequence is logical zero. logicalOne : `'T` The value that is returned if the value of the binary sequence is logical one. startValue : `uint64` The initial value of the sequence. Normally, this value is initialized with the value of the sequence length. Here you can provide any other value that is non-zero when and-ing it with the sequence length. Returns: `IEnumerable<'T>` Values of the maximum length sequence, where a logical value of zero is mapped to the parameter logicalZero and a logical one is mapped to logicalOne.
`this.Length` Full Usage: `this.Length` Returns: `int`	Gets the length of the sequence as an Int32 value. If the sequence length is greater than int.MaxValue, an InvalidCastException will be thrown. Returns: `int`
`this.LongLength` Full Usage: `this.LongLength` Returns: `uint64`	Gets the length of the sequence. This is the repeat period of the sequence. Returns: `uint64`
`this.NumberOfStages` Full Usage: `this.NumberOfStages` Returns: `int`	Gets the number of stages. This is the number of flip-flops that is needed to generate a maximum length sequence with discrete hardware. The sequence length is 2^numberOfStages-1. Returns: `int`
`this.TapValue` Full Usage: `this.TapValue`	Gets or sets the tap value. When setting the tap value, only basic tests will be made to ensure its validity. Thus, it can not be fully ensured that the provided tap value will generate a maximum length sequence.

Static members

Static member	Description
`MaximumLengthSequence.FromMinimumSequenceLength(sequenceLength)` Full Usage: `MaximumLengthSequence.FromMinimumSequenceLength(sequenceLength)` Parameters: sequenceLength : `int` - The minimum length of the binary sequency. If the provided value is not a number (2^k-1), the value will be rounded up to the next possible sequence length. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given minimum sequence length.	Constructs a new instance of the MaximumLengthSequence class with a minimum length given by the argument. sequenceLength : `int` The minimum length of the binary sequency. If the provided value is not a number (2^k-1), the value will be rounded up to the next possible sequence length. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given minimum sequence length.
`MaximumLengthSequence.FromMinimumSequenceLength(sequenceLength)` Full Usage: `MaximumLengthSequence.FromMinimumSequenceLength(sequenceLength)` Parameters: sequenceLength : `uint64` - The minimum length of the binary sequency. If the provided value is not a number (2^k-1), the value will be rounded up to the next possible sequence length. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given minimum sequence length.	Constructs a new instance of the MaximumLengthSequence class with a minimum length given by the argument. sequenceLength : `uint64` The minimum length of the binary sequency. If the provided value is not a number (2^k-1), the value will be rounded up to the next possible sequence length. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given minimum sequence length.
`MaximumLengthSequence.FromNumberOfStages(numberOfStages)` Full Usage: `MaximumLengthSequence.FromNumberOfStages(numberOfStages)` Parameters: numberOfStages : `int` - The number of stages (2..64). The length of the resulting sequence is 2^numberOfStages-1. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given number of stages.	Constructs a new instance of the MaximumLengthSequence class froms the number of stages (bits, flip-flops). numberOfStages : `int` The number of stages (2..64). The length of the resulting sequence is 2^numberOfStages-1. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given number of stages.
`MaximumLengthSequence.FromTapValue(tapValue)` Full Usage: `MaximumLengthSequence.FromTapValue(tapValue)` Parameters: tapValue : `uint64` - The tap value. A basic test of the validity of the tap value will be made, although it can not be guaranteed that the given tap value is able to generate a maximum length sequence. The highest set bit of the tap value determines the length of the maximum length sequence. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given tap value.	Constructs a new instance of the MaximumLengthSequence class from a tap value given by the argument. tapValue : `uint64` The tap value. A basic test of the validity of the tap value will be made, although it can not be guaranteed that the given tap value is able to generate a maximum length sequence. The highest set bit of the tap value determines the length of the maximum length sequence. Returns: `MaximumLengthSequence` The constructed instance of the MaximumLengthSequence class with the given tap value.
`MaximumLengthSequence.GetSequenceLengthFromMinimumSequenceLength(sequenceLength)` Full Usage: `MaximumLengthSequence.GetSequenceLengthFromMinimumSequenceLength(sequenceLength)` Parameters: sequenceLength : `int` - The minimum length of the binary sequency. Returns: `int` Next possible sequence length that is equal to or greater than the provided sequenceLength.	Gets the next possible sequence length that is equal to or greater than the provided sequenceLength. sequenceLength : `int` The minimum length of the binary sequency. Returns: `int` Next possible sequence length that is equal to or greater than the provided sequenceLength.
`MaximumLengthSequence.GetSequenceLengthFromMinimumSequenceLength(sequenceLength)` Full Usage: `MaximumLengthSequence.GetSequenceLengthFromMinimumSequenceLength(sequenceLength)` Parameters: sequenceLength : `uint64` - The minimum length of the binary sequency. Returns: `uint64` Next possible sequence length that is equal to or greater than the provided sequenceLength.	Gets the next possible sequence length that is equal to or greater than the provided sequenceLength. sequenceLength : `uint64` The minimum length of the binary sequency. Returns: `uint64` Next possible sequence length that is equal to or greater than the provided sequenceLength.