Class Cat

Hierarchy

Constructors

constructor

new Cat(destructuredParam?): Cat
Create a Cat object. This expects an single object parameter with the following keys
Parameters
- destructuredParam: CatInput = {}
  
  method: ability estimator, e.g. MLE or EAP, default = 'MLE' itemSelect: the method of item selection, e.g. "MFI", "random", "closest", default method = 'MFI' nStartItems: first n trials to keep non-adaptive selection startSelect: rule to select first n trials theta: initial theta estimate minTheta: lower bound of theta maxTheta: higher bound of theta prior: the prior distribution randomSeed: set a random seed to trace the simulation
Returns Cat
- Defined in index.ts:50

Properties

`Private` _nItems

_nItems: number

`Private` `Readonly` _resps

_resps: (0 | 1)[]

`Private` `Readonly` _rng

_rng: PRNG

`Private` _seMeasurement

_seMeasurement: number

`Private` _theta

_theta: number

`Private` `Readonly` _zetas

_zetas: Zeta[]

itemSelect

itemSelect: string

maxTheta

maxTheta: number

method

method: string

minTheta

minTheta: number

nStartItems

nStartItems: number

prior

prior: number[][]

startSelect

startSelect: string

Accessors

nItems

get nItems(): number
Returns number
- Defined in index.ts:87

resps

get resps(): (0 | 1)[]
Returns (0 | 1)[]
- Defined in index.ts:91

seMeasurement

get seMeasurement(): number
Returns number
- Defined in index.ts:83

theta

get theta(): number
Returns number
- Defined in index.ts:79

zetas

get zetas(): Zeta[]
Returns Zeta[]
- Defined in index.ts:95

Methods

`Private` calculateSE

calculateSE(): void
calculate the standard error of ability estimation

Returns void
- Defined in index.ts:190

`Private` estimateAbilityEAP

estimateAbilityEAP(): number
Returns number
- Defined in index.ts:152

`Private` estimateAbilityMLE

estimateAbilityMLE(): any
Returns any
- Defined in index.ts:164

findNextItem

findNextItem(stimuli, itemSelect?, deepCopy?): {
    nextStimulus: Stimulus;
    remainingStimuli: Stimulus[];
} | {
    nextStimulus: {
        difficulty: number;
        fisherInformation: number;
    };
    remainingStimuli: {
        difficulty: number;
        fisherInformation: number;
    }[];
}
find the next available item from an input array of stimuli based on a selection method

remainingStimuli is sorted by fisher information to reduce the computation complexity for future item selection
Parameters
- stimuli: Stimulus[]
  
  an array of stimulus
- itemSelect: string = ...
  
  the item selection method
- deepCopy: boolean = true
  
  default deepCopy = true
Returns {
    nextStimulus: Stimulus;
    remainingStimuli: Stimulus[];
} | {
    nextStimulus: {
        difficulty: number;
        fisherInformation: number;
    };
    remainingStimuli: {
        difficulty: number;
        fisherInformation: number;
    }[];
}
- Defined in index.ts:205

`Private` likelihood

likelihood(theta): number
Parameters
- theta: number
Returns number
- Defined in index.ts:180

`Private` negLikelihood

negLikelihood(thetaArray): number
Parameters
- thetaArray: number[]
Returns number
- Defined in index.ts:176

`Private` randomInteger

randomInteger(min, max): number
return a random integer between min and max
Parameters
- min: number
  
  The minimum of the random number range (include)
- max: number
  
  The maximum of the random number range (include)
Returns number
- random integer within the range
- Defined in index.ts:298

`Private` selectorClosest

selectorClosest(arr): {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}
Parameters
- arr: Stimulus[]
Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}
- nextStimulus: Stimulus
- remainingStimuli: Stimulus[]
- Defined in index.ts:272

`Private` selectorMFI

selectorMFI(arr): {
    nextStimulus: {
        difficulty: number;
        fisherInformation: number;
    };
    remainingStimuli: {
        difficulty: number;
        fisherInformation: number;
    }[];
}
Parameters
- arr: Stimulus[]
Returns {
    nextStimulus: {
        difficulty: number;
        fisherInformation: number;
    };
    remainingStimuli: {
        difficulty: number;
        fisherInformation: number;
    }[];
}
- nextStimulus: {
  difficulty: number;
  fisherInformation: number;
  }
  - difficulty: number
  - fisherInformation: number
- remainingStimuli: {
  difficulty: number;
  fisherInformation: number;
  }[]
- Defined in index.ts:234

`Private` selectorMiddle

selectorMiddle(arr): {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}
Parameters
- arr: Stimulus[]
Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}
- nextStimulus: Stimulus
- remainingStimuli: Stimulus[]
- Defined in index.ts:255

`Private` selectorRandom

selectorRandom(arr): {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}
Parameters
- arr: Stimulus[]
Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}
- nextStimulus: Stimulus
- remainingStimuli: Stimulus[]
- Defined in index.ts:283

updateAbilityEstimate

updateAbilityEstimate(zeta, answer, method?): void
use previous response patterns and item params to calculate the estimate ability based on a defined method
Parameters
- zeta: Zeta | Zeta[]
  
  last item param
- answer: 0 | 1 | (0 | 1)[]
  
  last response pattern
- method: string = ...
Returns void
- Defined in index.ts:132

`Static` `Private` validateItemSelect

validateItemSelect(itemSelect): string
Parameters
- itemSelect: string
Returns string
- Defined in index.ts:108

`Static` `Private` validateMethod

validateMethod(method): string
Parameters
- method: string
Returns string
- Defined in index.ts:99

`Static` `Private` validateStartSelect

validateStartSelect(startSelect): string
Parameters
- startSelect: string
Returns string
- Defined in index.ts:117

Class Cat

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

destructuredParam: CatInput = {}

Returns Cat

Properties

Private _nItems

Private Readonly _resps

Private Readonly _rng

Private _seMeasurement

Private _theta

Private Readonly _zetas

itemSelect

maxTheta

method

minTheta

nStartItems

prior

startSelect

Accessors

nItems

Returns number

resps

Returns (0 | 1)[]

seMeasurement

Returns number

theta

Returns number

zetas

Returns Zeta[]

Methods

Private calculateSE

Returns void

Private estimateAbilityEAP

Returns number

Private estimateAbilityMLE

Returns any

findNextItem

Parameters

stimuli: Stimulus[]

itemSelect: string = ...

deepCopy: boolean = true

Returns { nextStimulus: Stimulus; remainingStimuli: Stimulus[]; } | { nextStimulus: { difficulty: number; fisherInformation: number; }; remainingStimuli: { difficulty: number; fisherInformation: number; }[]; }

Private likelihood

Parameters

theta: number

Returns number

Private negLikelihood

Parameters

thetaArray: number[]

Returns number

Private randomInteger

Parameters

min: number

max: number

Returns number

Private selectorClosest

Parameters

arr: Stimulus[]

Returns { nextStimulus: Stimulus; remainingStimuli: Stimulus[]; }

nextStimulus: Stimulus

remainingStimuli: Stimulus[]

Private selectorMFI

Parameters

arr: Stimulus[]

Returns { nextStimulus: { difficulty: number; fisherInformation: number; }; remainingStimuli: { difficulty: number; fisherInformation: number; }[]; }

nextStimulus: { difficulty: number; fisherInformation: number; }

difficulty: number

fisherInformation: number

remainingStimuli: { difficulty: number; fisherInformation: number; }[]

Private selectorMiddle

Parameters

arr: Stimulus[]

`Private` _nItems

`Private` `Readonly` _resps

`Private` `Readonly` _rng

`Private` _seMeasurement

`Private` _theta

`Private` `Readonly` _zetas

`Private` calculateSE

`Private` estimateAbilityEAP

`Private` estimateAbilityMLE

Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
} | {
nextStimulus: {
difficulty: number;
fisherInformation: number;
};
remainingStimuli: {
difficulty: number;
fisherInformation: number;
}[];
}

`Private` likelihood

`Private` negLikelihood

`Private` randomInteger

`Private` selectorClosest

Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}

`Private` selectorMFI

Returns {
nextStimulus: {
difficulty: number;
fisherInformation: number;
};
remainingStimuli: {
difficulty: number;
fisherInformation: number;
}[];
}

nextStimulus: {
difficulty: number;
fisherInformation: number;
}

remainingStimuli: {
difficulty: number;
fisherInformation: number;
}[]

`Private` selectorMiddle

Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}

`Private` selectorRandom

Returns {
nextStimulus: Stimulus;
remainingStimuli: Stimulus[];
}

`Static` `Private` validateItemSelect

`Static` `Private` validateMethod

`Static` `Private` validateStartSelect