Class VirtuallyRotatedTextWithTerminator

A text string with a terminator character which has been rotated leftwards or rightwards, of a number of positions (0 included).

Inheritance
System.Object
VirtuallyRotatedTextWithTerminator
Implements
IValueEnumerable<System.Char>
IEnumerable<System.Char>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: MoreStructures
Assembly: MoreStructures.dll
Syntax
public class VirtuallyRotatedTextWithTerminator : IValueEnumerable<char>, IEquatable<VirtuallyRotatedTextWithTerminator>
Remarks

A virtually rotated terminator-terminated text is required by Burrows-Wheeler Transform construction, when the length of the text is too high to build the Burrows-Wheeler Matrix, which would have n^2 items.

Constructors

| Improve this Doc View Source

VirtuallyRotatedTextWithTerminator(RotatedTextWithTerminator, Int32)

A text string with a terminator character which has been rotated leftwards or rightwards, of a number of positions (0 included).

Declaration
public VirtuallyRotatedTextWithTerminator(RotatedTextWithTerminator Underlying, int Rotation)
Parameters
Type Name Description
RotatedTextWithTerminator Underlying

The TextWithTerminator instance which has been rotated.
System.Int32 Rotation

The number of characters to rotate: positive = rightwards, negative = leftwards.
Remarks

A virtually rotated terminator-terminated text is required by Burrows-Wheeler Transform construction, when the length of the text is too high to build the Burrows-Wheeler Matrix, which would have n^2 items.

Properties

| Improve this Doc View Source

Item[Index]

Select a part of Underlying by the provided index (either w.r.t. the start or to the end of the text), applying the Rotation. Treat index as circular, over modulo the length of Underlying.

Declaration
public char this[Index index] { get; }
Parameters
Type Name Description
Index index

The index applied to the underlying string.
Property Value
Type Description
System.Char

A char containing the selected part.
| Improve this Doc View Source

Rotation

Declaration
public int Rotation { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Underlying

Declaration
public RotatedTextWithTerminator Underlying { get; set; }
Property Value
Type Description
RotatedTextWithTerminator

Methods

| Improve this Doc View Source

CompareTo(VirtuallyRotatedTextWithTerminator)

Declaration
public int CompareTo(VirtuallyRotatedTextWithTerminator other)
Parameters
Type Name Description
VirtuallyRotatedTextWithTerminator other
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator<char> GetEnumerator()
Returns
Type Description
IEnumerator<System.Char>

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Implements

IEnumerable<>
IComparable<>
System.IEquatable<T>

Extension Methods