Class StringSet

Static Readonly empty

hasEmptyWord

• get hasEmptyWord(): boolean

• true if this set contains the empty word.

  Returns boolean

hasSingleCharacter

• get hasSingleCharacter(): boolean

• true if this set contains at least one single-character word.

  This is equivalent to this.getSingleCharacter() !== undefined.

  Returns boolean

isEmpty

• get isEmpty(): boolean

• true if this set is empty.

  Returns boolean

wordSets

• get wordSets(): readonly ReadonlyWordSet[]

• The words of this set with toCharSet applied to each character.

  Word sets are guaranteed to be sorted by ascending length.

  Note: This is a lazy getter. Try to avoid calling it for best performance.

  Returns readonly ReadonlyWordSet[]

equals

• equals(other: StringSet): boolean

• Returns whether this set is equal to the given set.

  Equality is defined as the wordSets of both sets being the same formal language.

  Parameters

  • other: StringSet

  Returns boolean

getLengthRange

• getLengthRange(): undefined | {
      max: number;
      min: number;
  }

• Returns the minimum and maximum length of words in this set.

  If this set is empty, undefined will be returned returned.

  Returns undefined | {
      max: number;
      min: number;
  }

getSingleCharacters

• getSingleCharacters(): undefined | CharSet

• Returns a set of all single-character words in this set or undefined if this set contains no single-character words.

  Returns undefined | CharSet

intersect

• intersect(other: StringSet): StringSet

• Returns the intersection of this set and the given set.

  Note: This operation is only allowed if all sets are compatible.

  Parameters

  • other: StringSet

  Returns StringSet

isCompatibleWith

• isCompatibleWith(other: StringSet): boolean

• Returns whether this set is compatible with the given set. Compatibility is defined as follows:

  1. The empty set is compatible with all sets.
  2. Sets with different case folding are incompatible.

  Parameters

  • other: StringSet

  Returns boolean

isDisjointWith

• isDisjointWith(other: StringSet): boolean

• Parameters

  • other: StringSet

  Returns boolean

isProperSubsetOf

• isProperSubsetOf(other: StringSet): boolean

• Returns whether this ⊂ other.

  Parameters

  • other: StringSet

  Returns boolean

isProperSupersetOf

• isProperSupersetOf(other: StringSet): boolean

• Returns whether this ⊃ other.

  Parameters

  • other: StringSet

  Returns boolean

isSubsetOf

• isSubsetOf(other: StringSet): boolean

• Returns whether this ⊆ other.

  Parameters

  • other: StringSet

  Returns boolean

isSupersetOf

• isSupersetOf(other: StringSet): boolean

• Returns whether this ⊇ other.

  Parameters

  • other: StringSet

  Returns boolean

union

• union(...others: StringSet[]): StringSet

• Returns the union of all given sets.

  Note: This operation is only allowed if all sets are compatible.

  Parameters

  • Rest ...others: StringSet[]

  Returns StringSet

without

• without(other: StringSet): StringSet

• Returns this set without the strings of the given set.

  Note: This operation is only allowed if all sets are compatible.

  Parameters

  • other: StringSet

  Returns StringSet

withoutEmptyWord

• withoutEmptyWord(): StringSet

• Removes the empty word from this set.

  Returns StringSet

withoutSingleCharacters

• withoutSingleCharacters(): StringSet

• Removes all single-character words from this set.

  Returns StringSet

Static from

• from(words: Iterable<ReadonlyWord>, caseFolding: CharCaseFolding): StringSet

• Parameters

  • words: Iterable<ReadonlyWord>

  • caseFolding: CharCaseFolding

  Returns StringSet

Static fromWord

• fromWord(word: ReadonlyWord, caseFolding: CharCaseFolding): StringSet

• Parameters

  • word: ReadonlyWord

  • caseFolding: CharCaseFolding

  Returns StringSet