Prose.Text

References
public sealed class Prose.Text : IComparable<Prose.Text>, IEquatable<Prose.Text>
Represents a string with alternating textual and numeric fragments. This makes mixed number/text comparisons much faster and more reliable.

Properties

Count

#
public int Count { get; }
Gets the total number of fragments.

Fragments

#
public IEnumerable<object> Fragments { get; }
Enumerate over all fragments in this text, returning either a string, or the numeric value.

IsEmpty

#
public bool IsEmpty { get; }
Gets whether this string is empty.

Length

#
public int Length { get; }
Gets the total length of the entire text.

Methods

Comparer

#
public static IComparer<Prose.Text> Comparer(StringComparison comparison)
Create an IComparer<T> for Prose.Text.
Parameters:
comparison (StringComparison)Text fragment comparison to use.

CompareTo

#
public int CompareTo(Text other, StringComparison comparison)
Compare two alphanumeric strings.
Parameters:
other (Prose.Text)Other string.
comparison (StringComparison)Comparison for the string fragments.

CompareTo

#
public int CompareTo(Text other)
Compare two alphanumeric strings.
Parameters:
other (Prose.Text)Other string.

Create

#
public static Prose.Text Create(params object[] fragments)
Create a Prose.Text from a sequence of textual and numeric fragments.
Parameters:
fragments (params object[])A sequence of fragments. Either strings, doubles, integers, big integers, vectors or points.

Equals

#
public override bool Equals(object obj)
Parameters:
obj (object)
Overrides: Object.Equals

Equals

#
public bool Equals(Text other, StringComparison comparison)
Parameters:
other (Prose.Text)
comparison (StringComparison)

Equals

#
public bool Equals(Text other)
Parameters:
other (Prose.Text)

FragmentAt

#
public int FragmentAt(int charIndex)
Get the fragment which contains the given character index.
Parameters:
charIndex (int)

FragmentSpan

#
public (int index, int length) FragmentSpan(int index)
Gets the character span of a given fragment.
Parameters:
index (int)

GetHashCode

#
public override int GetHashCode()
Overrides: Object.GetHashCode

Parse

#
public static Prose.Text Parse(string text, bool considerVectors)
Parse a string and extract the alphabetic and numeric parts.
Parameters:
text (string)String to parse.
considerVectors (bool)If true, comma separated numbers will be interpreted as vectors.

TextFragment

#
public string TextFragment(int index)
Gets the string fragment at the given index.
Parameters:
index (int)

ToString

#
public override string ToString()
Recreate the original string.
Overrides: Object.ToString

ValueFragment

#
public object ValueFragment(int index)
Gets the string fragment or numeric value at the given index.
Parameters:
index (int)

Operators

OperationResultDescription
Prose.Text+Prose.TextProse.TextAppend one numeric string to another.

Convertors

OperationResultDescription
implicitstringProse.TextAuto convert a string into a Prose.Text.