Routines for working with statistics.

Functions

QstatRcl

Tells if VarRecall can be used to read the stat variables.

statEnd

Tells the system that the program is no more working on the stat variables.

statFree

Frees the stat variables (including regeq and regcoef) if they exist.

statStart

Creates stat vars and sets them to invalid values.

Global Variables

RM_Type

Global variable that specifies the type of the current stat operation.

Predefined Types

RegModelTypes

An enumeration for describing the different types of the current stat operation. [Explanation] This enum describes the correct values for RM_Type.

QstatRcl

AMS 2.00 or higher

short QstatRcl (void);

Tells if VarRecall can be used to read the stat variables.

It returns TRUE if the stat variables are valid, FALSE otherwise.

See also: statEnd, statStart, statFree, VarRecall

statEnd

AMS 2.00 or higher

void statEnd (void);

Tells the system that the program is no more working on the stat variables.

This function must be called when the work on the stat variables is finished.

statFree

AMS 2.00 or higher

void statFree (void);

Frees the stat variables (including regeq and regcoef) if they exist.

This function may set the dirty flag for the graph (this will force a regraph when the grapher is activated).

statStart

AMS 2.00 or higher

void statStart (void);

Creates stat vars and sets them to invalid values.

This function must be called prior to any modifications to the stat variables:

statStart(); // Creates and initializes the stat vars to invalid values.
RM_Type = ... // set to the type you want, see RM_Type
// do calculations
// store to stat vars with VarStore
statEnd(); // tell the system we are no more working on the stat variables...

statStart can throw 'Error: Memory'.

RM_Type

AMS 2.04 or higher

unsigned char RM_Type;

Global variable that specifies the type of the current stat operation.

Valid values for RM_Type are described in enum RegModelTypes.

RegModelTypes

enum RegModelTypes { RM_NONE, RM_MEDMED, RM_LIN, RM_LN, RM_EXP, RM_POWER, RM_QUAD, RM_CUBIC, RM_QUART, RM_LOGISTIC, RM_SIN };

An enumeration for describing the different types of the current stat operation.

This enum describes the correct values for RM_Type.

Return to the main index