Variable | Bayes Server

Represents a discrete or continuous random variable.

Note that variable names must be unique per network, and are case sensitive.

A {@link com.bayesserver.Node Node} in a Bayesian network can contain one or more variables.

Although a discrete variable can contain a different number of {@link com.bayesserver.State states}, a continuous variable always contains a single state.

Hierarchy

Variable

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Variable(): Variable
new Variable(name: string): Variable
new Variable(name: string, valueType: VariableValueType, kind: VariableKind): Variable
new Variable(name: string, valueType: VariableValueType): Variable
new Variable(name: string, states: number): Variable
new Variable(name: string, states: string[]): Variable
new Variable(name: string, states: State[]): Variable

- Defined in core.ts:35001
Initializes a new instance of the {@link com.bayesserver.Variable} class, with {@link com.bayesserver.VariableValueType} discrete and zero states.

Returns Variable
- Defined in core.ts:35008
Initializes a new instance of the {@link com.bayesserver.Variable} class, with {@link com.bayesserver.VariableValueType} discrete, zero states, and the specified name.

Parameters
- name: string
  
  The name of the variable. Can be null.
Returns Variable
- Defined in core.ts:35017
Initializes a new instance of the {@link com.bayesserver.Variable} class with the specified name, kind and value type. If discrete, no states are added.

Parameters
- name: string
  
  The name of the variable. Can be null.
- valueType: VariableValueType
  
  The value type, e.g. continuous or discrete.
- kind: VariableKind
  
  The kind of Variable, e.g. Probability, Decision or Utility.
Returns Variable
- Defined in core.ts:35031
Initializes a new instance of the {@link com.bayesserver.Variable} class with the specified name and value type. If discrete, no states are added.

Parameters
- name: string
  
  The name of the variable. Can be null.
- valueType: VariableValueType
  
  The value type, e.g. continuous or discrete.
Returns Variable
- Defined in core.ts:35042
Initializes a new instance of the {@link com.bayesserver.Variable} class, with {@link com.bayesserver.VariableValueType} discrete and the specified [name] and adds the number of states specified in [states].

exception

RangeError Raised when the [states] parameter is less than zero.

Parameters
- name: string
  
  The name of the variable. Can be null.
- states: number
  
  The number of states to add to the Variable. States will be given default names.
Returns Variable
- Defined in core.ts:35055
Initializes a new instance of the {@link com.bayesserver.Variable} class, with {@link com.bayesserver.VariableValueType} discrete and the specified name and adds the states specified in [states].

exception

ReferenceError Raised when [states] is null.

exception

Error Raised when the names in [states] are not unique, or are null or empty.

Parameters
- name: string
  
  The name of the variable. Can be null.
- states: string[]
  
  The number of states to add to the Variable. States will be given default names.
Returns Variable
- Defined in core.ts:35070
Initializes a new instance of the {@link com.bayesserver.Variable} class, with {@link com.bayesserver.VariableValueType} discrete and the specified name and adds the states specified in [states].

exception

ReferenceError Raised when [states] is null.

exception

Error Raised when the names in [states] are not unique, or are null or empty.

Parameters
- name: string
  
  The name of the variable. Can be null.
- states: State[]
  
  The number of states to add to the Variable. States will be given default names.
Returns Variable

Accessors

customProperties

get customProperties(): CustomPropertyCollection

- Defined in core.ts:35528
Gets custom properties associated with this instance.

Custom properties allow storage of custom information, which will be saved with the network.

Returns CustomPropertyCollection

description

get description(): string
set description(value: string): void

- Defined in core.ts:35587
An optional description for the variable.

Returns string
- Defined in core.ts:35594
An optional description for the variable.

Parameters
- value: string
Returns void

index

get index(): number

- Defined in core.ts:35709
The Index of this instance in the collection of variables belonging to a network, or -1 if the variable does not belong to a node and hence a network.

Returns number

kind

get kind(): VariableKind

- Defined in core.ts:35618
Gets the kind of variable, such as Probability, Decision or Utility.

Returns VariableKind

name

get name(): string
set name(value: string): void

- Defined in core.ts:35663
Gets the name of the variable.

When a variable is added to a network, its name must be unique. Comparisons are case sensitive.

Returns string
- Defined in core.ts:35672
Sets the name of the variable.

When a variable is added to a network, its name must be unique. Comparisons are case sensitive.

Parameters
- value: string
Returns void

node

get node(): Node

- Defined in core.ts:35650
Gets the {@link com.bayesserver.Node} this instance belongs to, if any.

Returns Node

The node the instance belongs to, if any.

stateValueType

get stateValueType(): StateValueType
set stateValueType(value: StateValueType): void

- Defined in core.ts:35385
Gets the type of value that states belonging to this variable can represent. For example an interval.

Returns StateValueType
- Defined in core.ts:35395
Sets the type of value that states belonging to this variable can represent. For example an interval.

Parameters
- value: StateValueType
Returns void

states

get states(): StateCollection

- Defined in core.ts:35629
Returns the collection of states belonging to the variable.

Continuous variables always have a single state.

see

com.bayesserver.State

Returns StateCollection

valueType

get valueType(): VariableValueType

- Defined in core.ts:35611
Gets the variable's value type, e.g. continuous or discrete.

Returns VariableValueType

The variable's value type.

Methods

_get_O_x_

_get_O_x_(): VariableId

- Defined in core.ts:35746
Returns VariableId

_rqqq_x_

_rqqq_x_(): void

- Defined in core.ts:35262
Returns void

_rqqu_x_

_rqqu_x_(): void

- Defined in core.ts:35447
Returns void

_rqrr_x_

_rqrr_x_(p_autogen24: string): void

- Defined in core.ts:35717
Parameters
- p_autogen24: string
Returns void

_rqrs_x_

_rqrs_x_(p_autogen25: State): void

- Defined in core.ts:35724
Parameters
- p_autogen25: State
Returns void

_rqrt_x_

_rqrt_x_(p_autogen26: string): void

- Defined in core.ts:35731
Parameters
- p_autogen26: string
Returns void

_rqru_x_

_rqru_x_(p_autogen27: State, p_autogen28: string, p_autogen29: string): void

- Defined in core.ts:35738
Parameters
- p_autogen27: State
- p_autogen28: string
- p_autogen29: string
Returns void

_setIndex

_setIndex(value: number): void

- Defined in core.ts:35713
Parameters
- value: number
Returns void

_setNode

_setNode(value: Node): void

- Defined in core.ts:35654
Parameters
- value: Node
Returns void

_set_O_x_

_set_O_x_(value: VariableId): void

- Defined in core.ts:35751
Parameters
- value: VariableId
Returns void

compareTo

compareTo(other: Variable): number

- Defined in core.ts:35372
inheritdoc

Parameters
- other: Variable
Returns number

copy

copy(): Variable

- Defined in core.ts:35476
Copies this instance.

Returns Variable

A new {@link com.bayesserver.Variable} instance.

findStateByValue

findStateByValue(value: any): State

- Defined in core.ts:35279
Finds a state based on a state value. E.g. finds the state who's interval contains the supplied value, or who's integer state value matches the supplied integer.

Parameters
- value: any
  
  The value to test against state values. Type will depend on StateValueType. e.g. pass a double if the state value type is a double interval.
Returns State

The matching state or null.

toString

toString(): string

- Defined in core.ts:35638
Returns the name of the variable, or an empty string if the name is null.

Returns string

A {@link String} containing the name of the variable which is empty if the name is null.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Variable

Parameters

name: string

Returns Variable

Parameters

name: string

valueType: VariableValueType

kind: VariableKind

Returns Variable

Parameters

name: string

valueType: VariableValueType

Returns Variable

Parameters

name: string

states: number

Returns Variable

Parameters

name: string

states: string[]

Returns Variable

Parameters

name: string

states: State[]

Returns Variable

Accessors

customProperties

Returns CustomPropertyCollection

description

Returns string

Parameters

value: string

Returns void

index

Returns number

kind

Returns VariableKind

name

Returns string

Parameters

value: string

Returns void

node

Returns Node

stateValueType

Returns StateValueType

Parameters

value: StateValueType

Returns void

states

Returns StateCollection

valueType

Returns VariableValueType

Methods

_get_O_x_

Returns VariableId

_rqqq_x_

Returns void

_rqqu_x_

Returns void

_rqrr_x_

Parameters

p_autogen24: string

Returns void

_rqrs_x_

Parameters

p_autogen25: State

Returns void

_rqrt_x_

Parameters

p_autogen26: string

Returns void

_rqru_x_