Node | Bayes Server

Represents a node with one or more variables in a Bayesian network.

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

To specify a distribution for a node, see the {@link com.bayesserver.Node#getDistribution} property.

To add a directed link between two nodes, it must be added through the {@link com.bayesserver.Network#getLinks Network.Links} property.

see: com.bayesserver.Network
see: com.bayesserver.Link

Hierarchy

Node

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

- Defined in core.ts:18719
Initializes a new instance of the {@link com.bayesserver.Node} class, with no variables, and no name.

Returns Node
- Defined in core.ts:18728
Initializes a new instance of the {@link com.bayesserver.Node} class with a specified {@link com.bayesserver.Variable} and assigns the name of the variable to the node.

Parameters
- variable: Variable
  
  A single variable for the node.
Returns Node
- Defined in core.ts:18737
Initializes a new instance of the {@link com.bayesserver.Node} class with the specified [name]. A {@link com.bayesserver.Variable} is automatically created for the node and assigned the same name as the node with the {@link com.bayesserver.VariableValueType} specified.

Parameters
- name: string
  
  The name to give the node and variable, which can be null or empty.
- valueType: VariableValueType
  
  The {@link com.bayesserver.VariableValueType} of the node variable, e.g. discrete or continuous.
- kind: VariableKind
  
  The kind of variable, e.g. Probability (standard), Decision or Utility.
Returns Node
- Defined in core.ts:18751
Initializes a new instance of the {@link com.bayesserver.Node} class with the specified [name]. A {@link com.bayesserver.Variable} is automatically created for the node and assigned the same name as the node with the {@link com.bayesserver.VariableValueType} specified.

Parameters
- name: string
  
  The name to give the node and variable, which can be null or empty.
- valueType: VariableValueType
  
  The {@link com.bayesserver.VariableValueType} of the node variable, e.g. discrete or continuous.
Returns Node
- Defined in core.ts:18763
Initializes a new instance of the {@link com.bayesserver.Node} class with the specified [name] and automatically adds a discrete {@link com.bayesserver.Variable} with the number of states specified in [states].

exception

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

Parameters
- name: string
  
  The name to give the node and variable, which can be null or empty.
- states: number
  
  The number of states to add to the automatically created {@link com.bayesserver.Variable}. States will be given default names.
Returns Node
- Defined in core.ts:18777
Initializes a new instance of the {@link com.bayesserver.Node} class, with the name of the node, automatically creating an associated discrete {@link com.bayesserver.Variable} and adds the states specified in [states] to that variable.

exception

ReferenceError Raised when [states] is null.

Parameters
- name: string
  
  The name to give the node and variable, which can be null or empty.
- states: string[]
  
  The number of states to add to the automatically created {@link com.bayesserver.Variable}. States will be given default names.
Returns Node
- Defined in core.ts:18791
Initializes a new instance of the {@link com.bayesserver.Node} class, with the name of the node, automatically creating an associated discrete {@link com.bayesserver.Variable} and adds the states specified in [states] to that variable.

exception

ReferenceError Raised when [states] is null.

Parameters
- name: string
  
  The name to give the node and variable, which can be null or empty.
- states: State[]
  
  The number of states to add to the automatically created {@link com.bayesserver.Variable}. States will be given default names.
Returns Node
- Defined in core.ts:18805
Initializes a new instance of the {@link com.bayesserver.Node} class with a specified name and a number of variables.

Parameters
- name: string
  
  The name to give the node and variable, which can be null or empty.
- variables: Variable[]
  
  The variable(s) represented by the node.
Returns Node

Accessors

bounds

get bounds(): Bounds
set bounds(value: Bounds): void

- Defined in core.ts:19155
Gets the size and location of the node.

Returns Bounds

The size and location of the node.
- Defined in core.ts:19164
Sets the size and location of the node.

Parameters
- value: Bounds
  
  The size and location of the node.
Returns void

The size and location of the node.

customProperties

get customProperties(): CustomPropertyCollection

- Defined in core.ts:19104
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:19821
An optional description for the node.

Returns string
- Defined in core.ts:19828
An optional description for the node.

Parameters
- value: string
Returns void

distribution

get distribution(): IDistribution
set distribution(value: IDistribution): void

- Defined in core.ts:19718
Returns the distribution currently associated with the {@link com.bayesserver.Node}. The distribution cannot be modified when it is assigned to a node. It is also automatically set to null, when certain structural changes occur (see remarks).

If a structural change occurs to the network that invalidates the current distribution, it is automatically set to null. This occurs in the following situations:States are added or removed from the node.States are added or removed from one of the node's parents.The {@link com.bayesserver.Node#getLinksIn} collection changes. I.e. adding or removing a parent node. Note that if a node is removed from a network, all of its links are automatically removed also.

exception

Error Raised when the distribution is invalid.

Returns IDistribution
- Defined in core.ts:19737
Returns the distribution currently associated with the {@link com.bayesserver.Node}. The distribution cannot be modified when it is assigned to a node. It is also automatically set to null, when certain structural changes occur (see remarks).

If a structural change occurs to the network that invalidates the current distribution, it is automatically set to null. This occurs in the following situations:States are added or removed from the node.States are added or removed from one of the node's parents.The {@link com.bayesserver.Node#getLinksIn} collection changes. I.e. adding or removing a parent node. Note that if a node is removed from a network, all of its links are automatically removed also.

exception

Error Raised when the distribution is invalid.

Parameters
- value: IDistribution
Returns void

distributionOptions

get distributionOptions(): NodeDistributionOptions

- Defined in core.ts:19146
Options that apply to all distributions of this instance.

Returns NodeDistributionOptions

distributions

get distributions(): NodeDistributions

- Defined in core.ts:19758
Returns the distributions associated with this instance with NodeDistributionKind = Probability. Some node types such as temporal nodes can have more than one distribution assigned to them.

Returns NodeDistributions

groups

get groups(): NodeGroupCollection

- Defined in core.ts:19111
Gets the groups this node belongs to.

Returns NodeGroupCollection

index

get index(): number

- Defined in core.ts:19881
The Index of this instance in the collection of nodes belonging to a network, or -1 if the node does not belong to a network.

Returns number

linksIn

get linksIn(): NodeLinkCollection

- Defined in core.ts:19867
Collection of incoming links (linking to parent nodes).

Returns NodeLinkCollection

linksOut

get linksOut(): NodeLinkCollection

- Defined in core.ts:19874
Collection of outgoing links (linking to child nodes).

Returns NodeLinkCollection

name

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

- Defined in core.ts:19765
The name of the node. Node names in a network must be unique, and comparisons are case sensitive.

Returns string
- Defined in core.ts:19772
The name of the node. Node names in a network must be unique, and comparisons are case sensitive.

Parameters
- value: string
Returns void

network

get network(): Network

- Defined in core.ts:19842
The {@link com.bayesserver.Network} the node belongs to. Value will be null unless the node has been added to a network.

Returns Network

temporalType

get temporalType(): TemporalType
set temporalType(value: TemporalType): void

- Defined in core.ts:19120
The {@link com.bayesserver.TemporalType} of the node. The default value is {@link com.bayesserver.TemporalType#Contemporal}.

exception

Error Raised if the node belongs to a network, in which case the TemporalType cannot be changed. s

Returns TemporalType
- Defined in core.ts:19129
The {@link com.bayesserver.TemporalType} of the node. The default value is {@link com.bayesserver.TemporalType#Contemporal}.

exception

Error Raised if the node belongs to a network, in which case the TemporalType cannot be changed. s

Parameters
- value: TemporalType
Returns void

variables

get variables(): NodeVariableCollection

- Defined in core.ts:19860
Collection of variables represented by the node.

Returns NodeVariableCollection

Methods

_setIndex

_setIndex(value: number): void

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

_setNetwork

_setNetwork(value: Network): void

- Defined in core.ts:19846
Parameters
- value: Network
Returns void

_ttu_x_

_ttu_x_(p_autogen15: StateCollection, p_autogen16: number, p_autogen17: State, p_autogen18: State, p_autogen19: CollectionAction, p_autogen20: boolean): void

- Defined in core.ts:19213
Parameters
- p_autogen15: StateCollection
- p_autogen16: number
- p_autogen17: State
- p_autogen18: State
- p_autogen19: CollectionAction
- p_autogen20: boolean
Returns void

_ttv_x_

_ttv_x_(): void

- Defined in core.ts:19232
Returns void

_tuq_x_

_tuq_x_(p_autogen28: NodeDistributionKey, p_autogen29: NodeDistributionKind, p_autogen30: function, p_autogen31: function): IDistribution

- Defined in core.ts:19434
Parameters
- p_autogen28: NodeDistributionKey
- p_autogen29: NodeDistributionKind
- p_autogen30: function
  - - (arg0: IList<VariableContext>): Table
    - Parameters
      - arg0: IList<VariableContext>
      Returns Table
- p_autogen31: function
  - - (arg0: IList<VariableContext>): CLGaussian
    - Parameters
      - arg0: IList<VariableContext>
      Returns CLGaussian
Returns IDistribution

copy

copy(): Node

- Defined in core.ts:19042
Makes a copy of this instance.

The copy does not include links or distribution(s).

Returns Node

The copy.

newDistribution

newDistribution(temporalOrder: number): IDistribution
newDistribution(key: NodeDistributionKey): IDistribution
newDistribution(kind: NodeDistributionKind): IDistribution
newDistribution(key: NodeDistributionKey, kind: NodeDistributionKind): IDistribution
newDistribution(): IDistribution

- Defined in core.ts:19273
Creates a new distribution suitable for the requested temporal order, however it is not assigned to the node. Use {@link com.bayesserver.Node#getDistributions} to perform the assignment.

See {@link com.bayesserver.NodeDistributions} for more information.

Note: if the resulting distribution contains continuous variables, but no discrete head variables, all table values are initialized to 1.

see

com.bayesserver.NodeDistributions

Parameters
- temporalOrder: number
  
  The order for the requested distribution.
Returns IDistribution

The new distribution.
- Defined in core.ts:19292
Creates a new distribution suitable for the requested temporal order/related node, however it is not assigned to the node. Use {@link com.bayesserver.Node#getDistributions} to perform the assignment.

See {@link com.bayesserver.NodeDistributions} for more information.

Note: if the resulting distribution contains continuous variables, but no discrete head variables, all table values are initialized to 1.

A noisy node is specified using multiple distributions, one for each parent and a leak distribution. Set the related node property to a parent, or set it to the current node to set the leak distribution.

see

com.bayesserver.NodeDistributions

Parameters
- key: NodeDistributionKey
  
  Identifies the order/related node for the requested distribution.
Returns IDistribution

The new distribution.
- Defined in core.ts:19309
Creates a new distribution with the given kind, however it is not assigned to the node. Use {@link com.bayesserver.Node#getDistributions} to perform the assignment. For temporal or noisy nodes us a different overload.

See {@link com.bayesserver.NodeDistributions} for more information.

Note: if the resulting distribution contains continuous variables, but no discrete head variables, all table values are initialized to 1.

see

com.bayesserver.NodeDistributions

Parameters
- kind: NodeDistributionKind
  
  The kind of distribution to create.
Returns IDistribution

The new distribution.
- Defined in core.ts:19332
Creates a new distribution suitable for the requested temporal order/related node, however it is not assigned to the node. Use {@link com.bayesserver.Node#getDistributions} to perform the assignment.

See {@link com.bayesserver.NodeDistributions} for more information.

Note: if the resulting distribution contains continuous variables, but no discrete head variables, all table values are initialized to 1.

Experience table entries are also initialized to 1.

A noisy node is specified using multiple distributions, one for each parent and a leak distribution. Set the related node property to a parent, or set it to the current node to set the leak distribution.

see

com.bayesserver.NodeDistributions

Parameters
- key: NodeDistributionKey
  
  Identifies the order/related node for the requested distribution.
- kind: NodeDistributionKind
  
  The kind of distribution to create.
Returns IDistribution

The new distribution.
- Defined in core.ts:19347
Creates a new distribution suitable for the node, however does not assign it to the node's {@link com.bayesserver.Node#getDistribution} property.

This method is useful for creating distributions appropriate for a node. However, the returned distribution cannot be set to {@link com.bayesserver.Node#getDistribution} until the distribution has been correctly specified.

Note: if the resulting distribution contains continuous variables, but no discrete head variables, all table values are initialized to 1.

exception

Error Raised if the node or one of it's parents has zero states.

Returns IDistribution

A new distribution.

toString

toString(): string

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

Returns string

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

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Node

Parameters

variable: Variable

Returns Node

Parameters

name: string

valueType: VariableValueType

kind: VariableKind

Returns Node

Parameters

name: string

valueType: VariableValueType

Returns Node

Parameters

name: string

states: number

Returns Node

Parameters

name: string

states: string[]

Returns Node

Parameters

name: string

states: State[]

Returns Node

Parameters

name: string

variables: Variable[]

Returns Node

Accessors

bounds

Returns Bounds

Parameters

value: Bounds

Returns void

customProperties

Returns CustomPropertyCollection

description

Returns string

Parameters

value: string

Returns void

distribution

Returns IDistribution

Parameters

value: IDistribution

Returns void

distributionOptions

Returns NodeDistributionOptions

distributions

Returns NodeDistributions

groups

Returns NodeGroupCollection

index

Returns number

links

Returns NodeLinkCollection

linksIn

Returns NodeLinkCollection

linksOut

Returns NodeLinkCollection

name

Returns string

Parameters

value: string

Returns void

network

Returns Network

temporalType

Returns TemporalType

Parameters

value: TemporalType

Returns void