qmatrix.md

ReImproveJS

Globals / QMatrix /

Class: QMatrix

Hierarchy

• QMatrix

Index

Constructors

• constructor

Properties

• actions
• hashFunction
• initialState
• states
• transitions

Accessors

• Actions
• FinalStates
• HashFunction
• InitialState
• States

Methods

• action
• checkAndGetState
• exists
• getGraphData
• getStateFromData
• hash
• registerAction
• registerState
• registerTransition
• removeStateFromFinals
• reset
• resetTransitions
• setStateAsFinal
• setStateAsInitial
• updateTransition
• defaultHash

Constructors

constructor

+ new QMatrix(hashFunction?: function): QMatrix

Defined in reimprove/algorithms/q/qmatrix.ts:26

Parameters:

■Optional hashFunction: function

▸ (data: QStateData): string

Parameters:

Name	Type
data	QStateData

Returns: QMatrix

---

Properties

Private actions

● actions: Map<string, QAction>

Defined in reimprove/algorithms/q/qmatrix.ts:21

---

Private Optional hashFunction

● hashFunction? : function

Defined in reimprove/algorithms/q/qmatrix.ts:28

Type declaration:

▸ (data: QStateData): string

Parameters:

Name	Type
data	QStateData

---

Private initialState

● initialState: QState

Defined in reimprove/algorithms/q/qmatrix.ts:26

---

Private states

● states: Map<string, QState>

Defined in reimprove/algorithms/q/qmatrix.ts:22

---

Private transitions

● transitions: Array<QTransition>

Defined in reimprove/algorithms/q/qmatrix.ts:23

---

Accessors

Actions

● get Actions(): Array<QAction>

Defined in reimprove/algorithms/q/qmatrix.ts:180

Returns: Array<QAction>

---

FinalStates

● get FinalStates(): QState[]

Defined in reimprove/algorithms/q/qmatrix.ts:164

Returns: QState[]

---

HashFunction

● get HashFunction(): function

Defined in reimprove/algorithms/q/qmatrix.ts:168

Returns: function

▸ (data: QStateData): string

Parameters:

Name	Type
data	QStateData

● set HashFunction(func: function): void

Defined in reimprove/algorithms/q/qmatrix.ts:172

Parameters:

■ func: function

▸ (data: QStateData): string

Parameters:

Name	Type
data	QStateData

Returns: void

---

InitialState

● get InitialState(): QState

Defined in reimprove/algorithms/q/qmatrix.ts:160

Returns: QState

---

States

● get States(): Array<QState>

Defined in reimprove/algorithms/q/qmatrix.ts:176

Returns: Array<QState>

---

Methods

action

▸ action(name: string): QAction

Defined in reimprove/algorithms/q/qmatrix.ts:73

Parameters:

Name	Type
name	string

Returns: QAction

---

Private checkAndGetState

▸ checkAndGetState(state: QState | QStateData | string): QState | undefined

Defined in reimprove/algorithms/q/qmatrix.ts:99

Parameters:

Name	Type
state	QState | QStateData | string

Returns: QState | undefined

---

exists

▸ exists(data: QStateData): boolean

Defined in reimprove/algorithms/q/qmatrix.ts:95

Parameters:

Name	Type
data	QStateData

Returns: boolean

---

getGraphData

▸ getGraphData(): object

Defined in reimprove/algorithms/q/qmatrix.ts:184

Returns: object

• edges: GraphEdge[]

• nodes: GraphNode[]

---

getStateFromData

▸ getStateFromData(data: QStateData): QState | undefined

Defined in reimprove/algorithms/q/qmatrix.ts:91

Parameters:

Name	Type
data	QStateData

Returns: QState | undefined

---

hash

▸ hash(data: QStateData): string

Defined in reimprove/algorithms/q/qmatrix.ts:77

Parameters:

Name	Type
data	QStateData

Returns: string

---

registerAction

▸ registerAction(action: QAction | string, data?: QActionData): void

Defined in reimprove/algorithms/q/qmatrix.ts:34

Parameters:

Name	Type
action	QAction | string
data?	QActionData

Returns: void

---

registerState

▸ registerState(data: QStateData, reward: number): QState

Defined in reimprove/algorithms/q/qmatrix.ts:38

Parameters:

Name	Type	Default
data	QStateData	-
reward	number	0

Returns: QState

---

registerTransition

▸ registerTransition(action: string, from: QState, to: QState, oppositeActionName?: string): QTransition

Defined in reimprove/algorithms/q/qmatrix.ts:48

Parameters:

Name	Type
action	string
from	QState
to	QState
oppositeActionName?	string

Returns: QTransition

---

removeStateFromFinals

▸ removeStateFromFinals(state: QState | string | QStateData): boolean

Defined in reimprove/algorithms/q/qmatrix.ts:140

Remove the final flag from a state. Can be also done through QState.Final = false

Parameters:

Name	Type
state	QState | string | QStateData

Returns: boolean

True if the state exists and was successfully modified, else false.

---

reset

▸ reset(): void

Defined in reimprove/algorithms/q/qmatrix.ts:150

Returns: void

---

resetTransitions

▸ resetTransitions(): void

Defined in reimprove/algorithms/q/qmatrix.ts:156

Returns: void

---

setStateAsFinal

▸ setStateAsFinal(state: QState | QStateData | string): boolean

Defined in reimprove/algorithms/q/qmatrix.ts:125

Sets a state as final, which means that stops the emulation. There can be many. Can be also done through QState.Final = true

Parameters:

Name	Type
state	QState | QStateData | string

Returns: boolean

True if the state was successfully modified, false if it does not exists or wasn't modified.

---

setStateAsInitial

▸ setStateAsInitial(state: QState | QStateData | string): boolean

Defined in reimprove/algorithms/q/qmatrix.ts:114

Sets a state as initial state. Be careful there can be only one !

Parameters:

Name	Type
state	QState | QStateData | string

Returns: boolean

---

updateTransition

▸ updateTransition(id: number, to: QState): QTransition | undefined

Defined in reimprove/algorithms/q/qmatrix.ts:64

Parameters:

Name	Type
id	number
to	QState

Returns: QTransition | undefined

---

Static defaultHash

▸ defaultHash(data: QStateData): string

Defined in reimprove/algorithms/q/qmatrix.ts:87

Parameters:

Name	Type
data	QStateData

Returns: string

---