Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NodeDistributionKey

Identifies a distribution assigned or to be assigned to a node.

Some nodes may have more than one distribution assigned to them (e.g. temporal nodes or noisy nodes), and this is used to differentiate between them.

Hierarchy

  • NodeDistributionKey

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Initializes a new instance of the NodeDistributionKey class with defaults.

    Returns NodeDistributionKey

  • Initializes a new instance of a NodeDistributionKey.

    Parameters

    • order: number

      The temporal order of the node distribution.

    Returns NodeDistributionKey

  • Initializes a new instance of a {@link com.bayesserver.NodeDistributionKey}.

    Parameters

    • relatedNode: Node

      The parent of the noisy node this distribution refers to, or the noisy node itself to identify the leak distribution. This will be null, unless the node is a noisy node.

    Returns NodeDistributionKey

  • Initializes a new instance of a {@link com.bayesserver.NodeDistributionKey}.

    Parameters

    • order: number

      The temporal order of the node distribution.

    • relatedNode: Node

      The parent of the noisy node this distribution refers to, or the noisy node itself to identify the leak distribution. This will be null, unless the node is a noisy node.

    Returns NodeDistributionKey

Accessors

order

  • get order(): number

  • Gets the temporal order of the related node distribution.

    Returns number

relatedNode

  • get relatedNode(): Node

  • Gets the parent of the noisy node this distribution refers to, or the noisy node itself to identify the leak distribution. This will be null, unless the node is a noisy node.

    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.

    Returns Node

Static default

  • Gets a default instance, which is equivalent to constructing a new instance with the default constructor.

    Returns NodeDistributionKey

Methods

compareTo

equals

  • Indicates whether the current object is equal to another object of the same type.

    Parameters

    Returns boolean

    true if the current object is equal to the [other] parameter; otherwise, false.