Class Solver

constructor

• new Solver(viewer: Viewer): Solver

• Parameters

  • viewer: Viewer

  Returns Solver

callback

grids

marks

maxGrids

maxMarks

maxPairs

numFactHits

numFacts

numGoodMarks

numGuesses

numMarks

numPairs

numRuleHits

numRules

numSolutions

okTriggers

puzzle

quitFlag

stats

workFlag

StaticMAX_LAWS

StaticMAX_LEVELS

addMark

• addMark(
      levelNum: number,
      levelSub: string,
      markType: MarkType,
      refNum: number,
      refSub: string,
      noun1: Noun,
      verb: Verb,
      noun2: Noun,
      reason: string,
      facts?: Fact[],
      refMark?: Mark,
      offFacts?: Fact[],
  ): number

• Submits potential mark. Note: If potential mark contradicts existing mark, either: (1) quit if potential mark is not assumption, or (2) undo last assumption.

  Parameters

  • levelNum: number

    Level number
  • levelSub: string

    Level character.
  • markType: MarkType

    Mark type.
  • refNum: number

    Reference number.
  • refSub: string

    Reference character.
  • noun1: Noun

    Noun 1.
  • verb: Verb

    Verb.
  • noun2: Noun

    Noun 2.
  • reason: string

    Reason for mark.
  • facts: Fact[] = []

    Facts referenced.
  • refMark: Mark = null

    Mark referenced.
  • offFacts: Fact[] = []

    Facts disabled by potential mark.

  Returns number

  status -1=Error, 0=Exists, 1=Entered.

addMarkByRule

• addMarkByRule(
      mark: Mark,
      rule: Rule,
      refSub: string,
      noun1: Noun,
      verb: Verb,
      noun2: Noun,
      reason: string,
  ): number

• Submits potential mark triggered by given rule invoked on given mark.

  Parameters

  • mark: Mark

    Mark referenced.
  • rule: Rule

    Rule referenced.
  • refSub: string

    Reference character.
  • noun1: Noun

    Noun 1.
  • verb: Verb

    Verb.
  • noun2: Noun

    Noun 2.
  • reason: string

    Reason for mark.

  Returns number

  status -1 = Error, 0 = Mark not entered, 1 = Mark entered.

asString

• asString(): string

• Returns string

canBeLinked

• canBeLinked(noun1: Noun, link: Link, slot2: Noun, i: number): boolean

• Determines if noun 1 can be related to slot 2, otherwise false. Called by Lawyer.

  Parameters

  • noun1: Noun

    Noun 1.
  • link: Link

    Link.
  • slot2: Noun

    Slot 2.
  • i: number

    Position 1 = First, 2 = Second.

  Returns boolean

  True if noun 1 can be related to slot 2, otherwise false.

canBeWith

• canBeWith(noun1: Noun, noun2: Noun): boolean

• Determines if noun 1 can be with noun 2.

  Parameters

  • noun1: Noun

    Noun 1.
  • noun2: Noun

    Noun 2.

  Returns boolean

  True if noun 1 can be with noun 2, otherwise false.

doQuit

• doQuit(): void

• Stops solving the puzzle. Called by Finder.doNextLevel, Finder.doAssumptions.

  Returns void

doWork

• doWork(): void

• Starts solving puzzle with sanity check. Called by viewer.doSolve.

  Returns void

getCommonNoun

• getCommonNoun(noun1: Noun, noun2: Noun, nounType3: NounType): Noun

• Returns first noun of noun type 3 that noun 1 and noun 2 can be with, otherwise null.

  Parameters

  • noun1: Noun

    Noun 1.
  • noun2: Noun

    Noun 2.
  • nounType3: NounType

    Noun Type 3.

  Returns Noun

  Noun of noun type 3, or null.

getGridMark

• getGridMark(noun1: Noun, noun2: Noun): Mark

• Returns mark in grid given by two nouns. Called by Lawyer.

  Parameters

  • noun1: Noun

    Noun 1.
  • noun2: Noun

    Noun 2.

  Returns Mark

  Mark.

getGridVerb

• getGridVerb(noun1: Noun, noun2: Noun): Verb

• Determines verb of mark given by two nouns, or possible verb if mark is null.

  Parameters

  • noun1: Noun

    Noun 1.
  • noun2: Noun

    Noun 2.

  Returns Verb

  Verb of mark given by two nouns, or possible verb if mark is null.

getNouns

• getNouns(noun1: Noun, nounType2: NounType): Noun[]

• Returns list of nouns of noun type 2 that may be with noun 1.

  Parameters

  • noun1: Noun

    Noun 1.
  • nounType2: NounType

    Noun Type 2.

  Returns Noun[]

  Array of nouns, which may be empty.

isMark

• isMark(noun1: Noun, verb: Verb, noun2: Noun): boolean

• Determines if mark already exists.

  Parameters

  • noun1: Noun

    Noun 1.
  • verb: Verb

    Verb.
  • noun2: Noun

    Noun 2.

  Returns boolean

  True if mark already exists, otherwise false.

maybeRelated

• maybeRelated(noun1: Noun, link: Link, noun2: Noun): boolean

• Determines if noun 1 is/maybe related to noun 2.
  Called by "New Self Improvement Committee".

  Parameters

  • noun1: Noun

    Noun1.
  • link: Link

    Link.
  • noun2: Noun

    Noun 2.

  Returns boolean

  True if noun 1 is/maybe related to noun 2, otherwise false.

reset

• reset(): void

• Resets the solver. Called by viewer.reset, setPuzzle.

  Returns void

sayFactViolation

• sayFactViolation(mark: Mark, fact: Fact): void

• Parameters

  • mark: Mark
  • fact: Fact

  Returns void

sayLawViolation

• sayLawViolation(msg: string, mark: Mark): void

• Parameters

  • msg: string
  • mark: Mark

  Returns void

sayLevel

• sayLevel(num: number, sub: string, callback: Function): void

• Parameters

  • num: number
  • sub: string
  • callback: Function

  Returns void

sayPlacers

• sayPlacers(mark: Mark, rule: Rule): void

• Parameters

  • mark: Mark
  • rule: Rule

  Returns void

sayRuleViolation

• sayRuleViolation(mark: Mark, rule: Rule): void

• Parameters

  • mark: Mark
  • rule: Rule

  Returns void

sayValidMark

• sayValidMark(mark: Mark): void

• Parameters

  • mark: Mark

  Returns void

setPuzzle

• setPuzzle(puzzle: Puzzle): void

• Sets the puzzle. Called by viewer.setPuzzle.

  Parameters

  • puzzle: Puzzle

    Puzzle object.

  Returns void

toString

• toString(): string

• Returns string

undoAssumption

• undoAssumption(): void

• Removes marks back to and including the last mark entered by Finder.
  Called by finder.doAssumptions, callback from removeMark.

  Returns void

undoUserMark

• undoUserMark(): void

• Removes marks back to and including the last mark entered by User.
  Called when User clicks the Undo button on the Grids form.

  Returns void

updateOption

• updateOption(key: string, val: boolean): void

• Updates variables affected by Setup form. Called by viewer.updateOption.

  Parameters

  • key: string

    Key.
  • val: boolean

    Value.

  Returns void