Class CharSet

Readonly maximum

Readonly ranges

isAll

• get isAll(): boolean

• Returns true if all characters in the range from 0 to this.maximum, including 0 and this.maximum, are in the set.

  Returns boolean

isEmpty

• get isEmpty(): boolean

• Returns true if this set doesn't contain any characters.

  Returns boolean

size

• get size(): number

• Returns the number of unique characters in the set.

  The returned number will be at least 0 and at most this.maximum + 1.

  Returns number

characters

• characters(): Iterable<Char>

• Returns an iterable of all characters in this set.

  Characters are sorted by ascending order and each character is yielded exactly once.

  Note: The iterable is stable. It can be iterated multiple times.

  Returns Iterable<Char>

commonCharacter

• commonCharacter(other: CharRange | CharSet): undefined | Char

• Returns any one of the common characters of this set and the given set or range.

  If this character set is disjoint with the given character set/range, then undefined will be returned.

  Parameters

  • other: CharRange | CharSet

  Returns undefined | Char

compare

• compare(other: CharSet): number

• Compares this set with given set and returns an integer value describing their relation. Two equivalent set are always guaranteed to return 0.

  The order defined by this function is guaranteed to be a total order. Apart from this, no other guarantees are given.

  Parameters

  • other: CharSet

  Returns number

equals

• equals(other: CharRange | CharSet): boolean

• Returns whether this and the given character set are equivalent.

  Two CharSets are equal if and only if:

  1. They have the same maximum.
  2. They contain the same characters.

  Since each set of characters has a unique range representation, 2 equal CharSets are guaranteed to have equal ranges.

  A CharSet and a CharRange are equal if and only if they contain the same characters.

  Parameters

  • other: CharRange | CharSet

  Returns boolean

has

• has(character: Char): boolean

• Returns whether this set contains the given character.

  Parameters

  • character: Char

  Returns boolean

intersect

• intersect(other: CharRange | CharSet): CharSet

• Returns the intersection of this set and the given set/ranges of characters.

  The returned set will have the same maximum as this set.

  Parameters

  • other: CharRange | CharSet

  Returns CharSet

  Throws

  RangeError If the maximum of the given set differs from the maximum of this set.

isDisjointWith

• isDisjointWith(other: CharRange | CharSet): boolean

• Returns whether this set and the given set (or range) are disjoint.

  Parameters

  • other: CharRange | CharSet

  Returns boolean

isProperSubsetOf

• isProperSubsetOf(other: CharRange | CharSet): boolean

• Returns whether this ⊂ other.

  Parameters

  • other: CharRange | CharSet

  Returns boolean

isProperSupersetOf

• isProperSupersetOf(other: CharRange | CharSet): boolean

• Returns whether this ⊃ other.

  Parameters

  • other: CharRange | CharSet

  Returns boolean

isSubsetOf

• isSubsetOf(other: CharRange | CharSet): boolean

• Returns whether this ⊆ other.

  Parameters

  • other: CharRange | CharSet

  Returns boolean

isSupersetOf

• isSupersetOf(other: CharRange | CharSet): boolean

• Returns whether this ⊇ other.

  Parameters

  • other: CharRange | CharSet

  Returns boolean

negate

• negate(): CharSet

• Returns the complement of this set.

  The returned set will have the same maximum as this set.

  Returns CharSet

resize

• resize(newMaximum: Char): CharSet

• Returns a character set with the given maximum.

  The ranges of the returned character set are equivalent to the ranges of this.intersect({ min: 0, max: newMaximum }).

  Parameters

  • newMaximum: Char

  Returns CharSet

toRangesString

• toRangesString(): string

• Returns a string representation of the ranges of this character set.

  The string representation has the following rules:

  1. Each character is represented as a hexadecimal number.
  2. Each range where min == max will be represented by the min character.
  3. Each range where min != max will be represented by min followed by ".." followed by max.
  4. The sequence of ranges will be joined together using ", ".

  The returned string representation will have the following format:

  string = [ ranges ]
  ranges = range *( ", " range )
  range  = +hex [ ".." +hex ]
  hex    = "a" | "b" | "c" | "d" | "e" | "f" | digit
  digit  = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
  Copy

  Returns string

toString

• toString(): string

• Returns a string representation of the character set.

  Returns string

toUnicodeString

• toUnicodeString(): string

• Returns a string representation of the Unicode ranges of this character set.

  The primary purpose of this function is provide an easy way to get a readable representation of a Unicode or Unicode-like character set. The format is optimized for ease of reading for humans.

  The format follows these rules:

  • If the character set is empty, empty will be returned.
  • If the character set contains all characters, all will be returned.
  • Ranges may be negated, which is indicated with not. E.g. not a b is the character set that contains all characters except for a and b.
  • A contiguous range of characters is represented using min-max where min and max are formatted characters.
  • Single characters are formatted as either:
    • a Unicode character (e.g. a),
    • a quoted Unicode character (e.g. '-'), or
    • a Unicode escape (e.g. U+FF).

  The returned string representation will have the following format:

  string  = "all" | "empty" | ranges | "not " ranges
  ranges  = range *( " " range )
  range   = char [ "-" char ]
  char    = literal | quoted | escape
  literal = ?Printable Unicode characters?
  literal = "'" ?any character? "'"
  escape  = "U+" +hex
  hex     = "A" | "B" | "C" | "D" | "E" | "F" | digit
  digit   = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
  Copy

  Returns string

union

• union(...data: (CharSet | Iterable<CharRange>)[]): CharSet

• Returns the union of this set and all given sets and character ranges.

  The returned set will have the same maximum as this set.

  Parameters

  • Rest ...data: (CharSet | Iterable<CharRange>)[]

  Returns CharSet

  Throws

  RangeError If the maximum of one of the given sets differs from the maximum of this set or if the maximum of one of the given ranges is greater than the maximum of this set.

without

• without(other: CharRange | CharSet): CharSet

• Returns a set that contains all characters of this set that are not in the given set/range.

  The returned set will have the same maximum as this set.

  Parameters

  • other: CharRange | CharSet

  Returns CharSet

  Throws

  RangeError If the maximum of the given set differs from the maximum of this set.

Static all

• all(maximum: Char): CharSet

• Returns a complete character set with the given maximum.

  Parameters

  • maximum: Char

    The greatest character which will be element of the set.

  Returns CharSet

Static empty

• empty(maximum: Char): CharSet

• Returns an empty character set with the given maximum.

  Parameters

  • maximum: Char

    The greatest character which can be element of the set.

  Returns CharSet

Static fromCharacter

• fromCharacter(maximum: Char, char: Char): CharSet

• Returns a character set which contains the given character.

  Parameters

  • maximum: Char

    The greatest character which will be element of the set.

  • char: Char

  Returns CharSet

  Throws

  RangeError if the maximum of the given range is greater than maximum.

Static fromCharacters

• fromCharacters(maximum: Char, characters: Iterable<Char>): CharSet

• Returns a character set which contains the given characters.

  Parameters

  • maximum: Char

    The greatest character which will be element of the set.

  • characters: Iterable<Char>

    A sorted collection of characters.

  Returns CharSet

  Throws

  RangeError if the given collection is not sorted or contains characters greater than maximum.

Static fromRange

• fromRange(maximum: Char, range: CharRange): CharSet

• Returns a character set which contains the given range.

  Parameters

  • maximum: Char

    The greatest character which will be element of the set.

  • range: CharRange

  Returns CharSet

  Throws

  RangeError if the maximum of the given range is greater than maximum.