Class CellBoard

Constructed using 2d array of Cells Maintains metadata about arary of Cells

Hierarchy

  • CellBoard

Constructors

constructor

Properties

cellGroups cells indexesPlaced indexesWithNote searchedGroups valuesPlaced

Methods

getCell getCellsInGroup getEmptyCellsInGroup getIndexesPlaced getIndexesWithNote getSearchedGroups getValuesPlaced removeNotes resetNotes resetSearchedGroups setSearchedGroups setValue

Constructors

constructor

Properties

Private cellGroups

cellGroups: Cell[][][]

Private cells

cells: Cell[][]

Private indexesPlaced

indexesPlaced: Group[][]

Private indexesWithNote

indexesWithNote: Group[][][]

Private searchedGroups

searchedGroups: boolean[][][]

Private valuesPlaced

valuesPlaced: Group[][]

Methods

getCell

  • Given a group and indexes returns the corresponding cell

    Returns

    Cell with given group and indexes

    Parameters

    • group: GroupEnum

      group e.g. row

    • groupIndex: number

      group index e.g. 5th row

    • index: number

      index e.g. 7th cell in 5th row

    Returns Cell

getCellsInGroup

  • Given group and its index returns all of the cells in it

    Returns

    array containing all cells in given group

    Parameters

    • group: GroupEnum

      group e.g. row

    • index: number

      index e.g. 7th row

    Returns Cell[]

getEmptyCellsInGroup

  • Given group and its index returns all of the empty cells in it

    Returns

    array containing all empty cells in given group

    Parameters

    • group: GroupEnum

      group e.g. row

    • index: number

      index e.g. 7th row

    Returns Cell[]

getIndexesPlaced

  • Gets indexes in which values have been placed in given group

    Returns

    Group object containing indexes with values placed in them in given group

    Parameters

    • group: GroupEnum

      Group type e.g. row

    • index: number

      index e.g. 2 = 3rd

    Returns Group

getIndexesWithNote

  • Given a group and a note returns Group object containing indexes of cells containing the note in the group

    Returns

    group containing indexes of cells in given group containing given note

    Parameters

    • groupType: GroupEnum

      group type e.g. row

    • index: number

      index e.g. 3 (4th row)

    • note: number

      note e.g. 4 (refers to "3")

    Returns Group

getSearchedGroups

  • Checks whether or not a given group has been searched for a given strategy already

    Returns

    whether or not given group has been searched for given strategy

    Parameters

    • strategyType: StrategyEnum

      strategy type e.g. amend notes

    • groupType: GroupEnum

      group type e.g. row

    • groupIndex: number

      group index e.g. 3 (4th cell in group)

    Returns boolean

getValuesPlaced

  • Gets values placed in given group e.g. Group representing 3rd row

    Returns

    Group object containing values placed in given row

    Parameters

    • group: GroupEnum

      Group type e.g. row

    • index: number

      index e.g. 2 = 3rd

    Returns Group

removeNotes

  • Removes given notes from given cell

    Parameters

    • row: number

      row Cell is in

    • column: number

      column Cell is in

    • notes: Group

      notes being removed from Cell

    Returns void

resetNotes

  • Adds all notes back into Cell (used for amend notes strategy)

    Parameters

    • row: number

      row Cell is in

    • column: number

      column Cell is in

    Returns void

resetSearchedGroups

  • Reset searchedGroups to false for all groups that given cell (which is being updated) is a part of

    Parameters

    • row: number

      row where updated cell is

    • column: number

      column where updated cell is

    Returns void

setSearchedGroups

  • Sets whether or not a given group has been searched for a given strategy already

    Parameters

    • strategyType: StrategyEnum

      strategy type e.g. amend notes

    • groupType: GroupEnum

      group type e.g. row

    • groupIndex: number

      group index e.g. 3 (4th cell in group)

    • searched: boolean

    Returns void

setValue

  • Sets given value for given cell and updates metadata

    Parameters

    • row: number

      row Cell is in

    • column: number

      column Cell is in

    • value: string

      value being placed in Cell

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc