Class UtilityNode
A UtilityNode represents a utility function. The utility function can depend on discrete chance and decision Nodes.
Implements
Inherited Members
Namespace: HAPI
Assembly: hugincs-9.4-netstandard2.0-x64.dll
Syntax
public class UtilityNode : Node, ICloneableRemarks
UtilityNodes are used in influence diagrams to represent utilities associated with decision options.
Constructors
UtilityNode(NetworkModel)
Constructs a new UtilityNode in a NetworkModel (i.e., a Class or a Domain).
Declaration
public UtilityNode(NetworkModel belongsTo)Parameters
| Type | Name | Description |
|---|---|---|
| NetworkModel | belongsTo | the NetworkModel in which the new UtilityNode should be created. |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
Methods
GenerateTable()
Generates the utility table of this UtilityNode from its model.
Declaration
public void GenerateTable()Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetCategory()
Returns the Category of this Node
Declaration
public override Node.Category GetCategory()Returns
| Type | Description |
|---|---|
| Node.Category |
Overrides
GetExpectedUtility()
Returns the expected utility associated with this UtilityNode.
Declaration
public float GetExpectedUtility()Returns
| Type | Description |
|---|---|
| float | expected utility associated with this UtilityNode. |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetKind()
Returns the Kind of this Node.
Declaration
public override Node.Kind GetKind()Returns
| Type | Description |
|---|---|
| Node.Kind |
Overrides
GetMaxUtility()
Returns the maximum possible utility associated with this UtilityNode. This is the largest utility value for this node with a positive probability as computed by the most recent inference operation.
Declaration
public float GetMaxUtility()Returns
| Type | Description |
|---|---|
| float | maximum possible utility associated with this UtilityNode. |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetMinUtility()
Returns the minimum possible utility associated with this UtilityNode. This is the smallest utility value for this node with a positive probability as computed by the most recent inference operation.
Declaration
public float GetMinUtility()Returns
| Type | Description |
|---|---|
| float | minimum possible utility associated with this UtilityNode. |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetSampledUtility()
Returns the sampled utility associated with this UtilityNode.
Declaration
public float GetSampledUtility()Returns
| Type | Description |
|---|---|
| float | sampled utility associated with this UtilityNode. |
Remarks
This is the utility value determined by the most recent call to Simulate().
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetVarianceOfUtility()
Returns the variance of the utility associated with this UtilityNode. This is the variance of the utility value computed by the most recent inference operation.
Declaration
public float GetVarianceOfUtility()Returns
| Type | Description |
|---|---|
| float | variance of the utility associated with this UtilityNode. |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |