Class IntervalDFNode
Interval discrete function node. Each state of an IntervalDFNode represents an interval.
Note: Return and argument types for methods in this class vary depending on the particular API DLL (x86/x64 platform, single/double precision) being used. Please read the section Using the Hugin C#/.NET Core/.NET 5/.NET 6 API.
Inherited Members
Namespace: HAPI
Assembly: hugincs-9.7-netstandard2.0-x64.dll
Syntax
public class IntervalDFNode : DiscreteFunctionNode, ICloneable, NumericDiscreteNodeConstructors
IntervalDFNode(DiscreteFunctionNode)
Constructs a new IntervalDFNode object corresponding to
the given DiscreteFunctionNode object node.
Declaration
public IntervalDFNode(DiscreteFunctionNode node)Parameters
| Type | Name | Description |
|---|---|---|
| DiscreteFunctionNode | node | The DiscreteFunctionNode to be converted. |
Remarks
The new object is identical to node
except that it will be an "interval" function node. As a
side-effect, node dies (that is, becomes
"not-alive"). And if node is an output
node, then all output clones associated with the node also die.
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
IntervalDFNode(NetworkModel)
Constructs a new IntervalDFNode.
Declaration
public IntervalDFNode(NetworkModel belongsTo)Parameters
| Type | Name | Description |
|---|---|---|
| NetworkModel | belongsTo |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
Methods
GetQuantile(double)
Returns the quantile corresponding to the specified
probability argument of the inverse cumulative
distribution function.
Declaration
public double GetQuantile(double probability)Parameters
| Type | Name | Description |
|---|---|---|
| double | probability |
Returns
| Type | Description |
|---|---|
| double |
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetStateIndex(double)
Returns the index of the state (interval) matching the specified value.
Declaration
public long GetStateIndex(double value)Parameters
| Type | Name | Description |
|---|---|---|
| double | value | An interval containing this value will be searched for. |
Returns
| Type | Description |
|---|---|
| long | The index of the state (interval) containing the specified value. |
Remarks
If there is no interval containing the specified value, -1 is returned.
Generic declaration:
public h_index_t GetStateIndex (double value)
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
GetStateValue(ulong)
Returns the low value of the interval associated with
state s.
Declaration
public double GetStateValue(ulong s)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | s | Index of the state. |
Returns
| Type | Description |
|---|---|
| double |
Remarks
To indicate the right endpoint of the rightmost interval,
specify s equal to the number of states of this node.
Generic declaration:
public double GetStateValue (size_t s)
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |
SetStateValue(ulong, double)
Sets the low value of the interval associated with state
s to v.
Declaration
public void SetStateValue(ulong s, double v)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | s | |
| double | v |
Remarks
To indicate the right endpoint of the rightmost interval,
specify s equal to the number of states of this
IntervalDCNode.
Generic declaration:
public void SetStateValue (size_t s, double v)
Exceptions
| Type | Condition |
|---|---|
| ExceptionHugin |