HAPI Namespace Reference

The HAPI namespace holds all Hugin C++ API identifiers. More...

Classes

class  AbsExpression
 Expression class representing the abs() function. More...
class  AddExpression
 Expression class representing the + operator. More...
class  AndExpression
 Expression class representing the Boolean and() function. More...
class  Attribute
 Attributes can be used to associate arbitrary data with a node or a NetworkModel (i.e., a Class or a Domain). More...
class  BetaDistribution
 Expression class representing the Beta distribution. More...
class  BinomialDistribution
 Expression class representing the Binomial distribution. More...
class  BooleanDCNode
 Boolean discrete chance node. The node has two states, true and false. More...
class  BooleanDDNode
 Boolean discrete decision node. More...
class  BooleanExpression
 A Boolean constant expression. More...
class  CeilExpression
 Expression class representing the ceil() function. More...
class  CGDistribution
 A CGDistribution encapsulates all information regarding the distribution of a ContinuousChanceNode. More...
class  Class
 The Class class is one of the principal structures in HUGIN. More...
class  ClassCollection
 A ClassCollection is one of the principal structures in HUGIN. More...
class  ClassParseListener
 The ClassParseListener interface is used when one wants to call the parseClasses (String, ParseListener) method of the ClassCollection class. More...
class  Clique
 Represents the cliques in the junction tree. More...
class  CompositeExpression
 The base class of all composite expressions (for example arithmetic operators and standard distribution functions). More...
class  ConstantExpression
 The ancestor of all expression classes representing a constant (label, number, or Boolean). More...
class  ContinuousChanceNode
 The Continuous chance node. More...
class  CosExpression
 Expression class representing the cos() function. More...
class  CoshExpression
 Expression class representing the cosh() function. More...
class  DefaultParseListener
 Provides a simple implementation of the ParseListener class. More...
class  DiscreteChanceNode
 This class is the ancestor of all discrete chance nodes. More...
class  DiscreteDecisionNode
 The discrete decision node. Base class for all decision nodes. More...
class  DiscreteNode
 This class is the ancestor of all discrete nodes. More...
class  DistributionDistribution
 Expression class representing the Distribution distribution. More...
class  DivideExpression
 Expression class representing the / operator. More...
class  Domain
 A domain is the HUGIN representation of a network. More...
class  EqualsExpression
 Expression class representing the == operator. More...
class  ExceptionAttribute
 Attempted to read a value associated with a non-existing attribute. More...
class  ExceptionBadKBFormat
 This file is not a valid Hugin KB file. More...
class  ExceptionBadKBPassword
 The supplied password does not match the password stored in the Hugin KB file. More...
class  ExceptionBadKBVersion
 This Hugin KB file is not supported. More...
class  ExceptionCaseStateTooLarge
 A case state index larger than 32767 has been specified. More...
class  ExceptionCGEvidenceIncorporated
 This operation is not supported when the junction tree potentials have CG evidence incorporated. More...
class  ExceptionCGLIMIDsNotSupported
 LIMIDs with CG nodes are not supported. More...
class  ExceptionChainGraph
 Chain graph: Zero probability found in parent potential. More...
class  ExceptionCompressed
 The operation is not supported on compressed domains. More...
class  ExceptionComputationFailed
 The probability/density function could not be computed. More...
class  ExceptionCyclicInstanceHierarchy
 Cyclic hierarchies of class instances are not allowed. More...
class  ExceptionCyclicNetwork
 A cycle has been detected in the network of the domain. More...
class  ExceptionDemo
 Attempted to work on domain, which exceeds the limits of the demo version. More...
class  ExceptionDivisionByZero
 Division by zero has been attempted. More...
class  ExceptionEnumeration
 The specified elimination sequence is invalid. More...
class  ExceptionError
 This is an impossible error. More...
class  ExceptionExpiredLicense
 The time limited evaluation license has expired. More...
class  ExceptionFastRetraction
 Logical relations in the distribution has caused a fast-retraction propagation to fail. More...
class  ExceptionHugin
 The generic Hugin Exception. More...
class  ExceptionIllegalBinding
 An actual input node is incompatible with the formal input node, or there are multiple occurrences of the same parent. More...
class  ExceptionInappropriateArguments
 Invalid arguments have been given to a standard mathematical or probability/density function. More...
class  ExceptionInconsistencyOrUnderflow
 Propagation of inconsistent evidence has been attempted. More...
class  ExceptionInsufficientStateRange
 The state range of the node is insufficient for the chosen standard distribution. More...
class  ExceptionInvalidEvidence
 The specified evidence violates the "free will" condition, or evidence on a decision node is not an instantiation. More...
class  ExceptionInvalidExpression
 The supplied expression is invalid (for example, wrong type). More...
class  ExceptionInvalidLicense
 Attempted to work on domain with invalid license information. More...
class  ExceptionInvalidName
 Names used for classes, nodes, and attributes must have the same form as a C identifier. More...
class  ExceptionInvalidProbabilityPotential
 A negative value or a zero-sum distribution has been found in a probability potential. More...
class  ExceptionInvalidStateValues
 The state values of a numeric node do not form an increasing sequence. More...
class  ExceptionIO
 A fatal error occurred during an input or output operation. More...
class  ExceptionLocale
 The Hugin API could not establish the C locale. More...
class  ExceptionLowDensity
 The density of the evidence presented is too low to represent as a positive floating-point number. More...
class  ExceptionMemory
 Hugin ran out of memory while carrying out some operation. More...
class  ExceptionNoEquilibrium
 The junction tree potentials are inconsistent. More...
class  ExceptionNoFileName
 The NetworkModel does not have a file name associated with it. More...
class  ExceptionNormalization
 Normalization with a zero normalization constant has been attempted. More...
class  ExceptionNotCompiled
 The operation requires a compiled domain. More...
class  ExceptionNoValue
 No value has been specified (or the specified value has become invalid). More...
class  ExceptionOverflow
 Overflow occurred during propagation. More...
class  ExceptionParse
 An error occurred while parsing a NET specification. More...
class  ExceptionRounding
 Possibly significant floating-point rounding error detected. More...
class  ExceptionSizeTooLarge
 The true size is too large to represent within type size_t. More...
class  ExceptionSyntax
 A syntax error has been detected while parsing an expression. More...
class  ExceptionTableSize
 Attempted to use a table of wrong dimensions, e.g., while setting data of a table. More...
class  ExceptionTableTooLarge
 The compressed version of some non-clique table is too large. More...
class  ExceptionTwice
 An attempt has been made to assign a name that is already in use to a node or a class. More...
class  ExceptionUsage
 An API function was called with an invalid argument (for example, a NULL object was passed to a function that expects a non-NULL argument). More...
class  ExceptionZeroVariance
 Zero variance detected during a conditioning operation. More...
class  ExpExpression
 Expression class representing the exp() function. More...
class  ExponentialDistribution
 Expression class representing the Exponential distribution. More...
class  Expression
 Expression is the ancestor of all expression classes. More...
class  FloorExpression
 Expression class representing the floor() function. More...
class  FunctionNode
 A FunctionNode represents a real-valued function. More...
class  GammaDistribution
 Expression class representing the Gamma distribution. More...
class  GeometricDistribution
 Expression class representing the Geometric distribution. More...
class  GreaterThanExpression
 Expression class representing the > operator. More...
class  GreaterThanOrEqualsExpression
 Expression class representing the >= operator. More...
class  IfExpression
 Expression class representing a conditional expression. More...
class  InstanceNode
 InstanceNodes are the key building block of object-oriented Bayesian networks and LIMIDs. More...
class  IntervalDCNode
 Interval discrete chance node. Each state represents an interval. More...
class  IntervalDDNode
 Interval discrete decision node. More...
class  JunctionTree
 Thic class represents the junction trees in the compiled domain. More...
class  LabelExpression
 A label constant expression. More...
class  LabelledDCNode
 Labelled discrete chance node. More...
class  LabelledDDNode
 Labelled discrete decision node. More...
class  LessThanExpression
 Expression class representing the < operator. More...
class  LessThanOrEqualsExpression
 Expression class representing the <= operator. More...
class  Log10Expression
 Expression class representing the Log10() function. More...
class  Log2Expression
 Expression class representing the log2() function. More...
class  LogExpression
 Expression class representing the log() function. More...
class  LogNormalDistribution
 Expression class representing the LogNormal distribution. More...
class  MaxExpression
 Expression class representing the max() function. More...
class  MinExpression
 Expression class representing the min() function. More...
class  Model
 A Model is a compact description of a table. More...
class  ModExpression
 Expression class representing the mod() function. More...
class  MultiplyExpression
 Expression class representing the * operator. More...
class  NegateExpression
 Expression class representing the unary - operator. More...
class  NegativeBinomialDistribution
 Expression class representing the Negative Binomial distribution. More...
class  NetworkModel
 NetworkModel is the ancestor of both Domain and Class. More...
class  Node
 Nodes are one of the fundamental objects used in the construction of Bayesian networks and LIMIDs. More...
class  NodeExpression
 An expression representing the value of a discrete chance node or decision node. More...
class  NoisyOrDistribution
 Expression class representing the NoisyOr distribution. More...
class  NormalDistribution
 Expression class representing the Normal (also known as the Gaussian) distribution. More...
class  NotEqualsExpression
 Expression class representing the != operator. More...
class  NotExpression
 Expression class representing the Boolean not() function. More...
class  NumberedDCNode
 Numbered discrete chance node. More...
class  NumberedDDNode
 Numbered discrete decision node. More...
class  NumberExpression
 A numeric constant expression. More...
class  OrExpression
 Expression class representing the Boolean or() function. More...
class  ParseListener
 The ParseListener class is an abstract class, which provides an interface for the other parse listeners to use. More...
class  PERTDistribution
 Expression class representing the PERT distribution. More...
class  PoissonDistribution
 Expression class representing the Poisson distribution. More...
class  PowerExpression
 Expression class representing the ^ operator. More...
class  SinExpression
 Expression class representing the sin() function. More...
class  SinhExpression
 Expression class representing the sinh() function. More...
class  SqrtExpression
 Expression class representing the sqrt() function. More...
class  SubtractExpression
 Expression class representing the binary - operator. More...
class  Table
 Hugin uses Tables for representing the conditional probability and utility potentials of individual Nodes, the probability and utility potentials on separators and Cliques of JunctionTrees, evidence potentials, etc. More...
class  TanExpression
 Expression class representing the tan() function. More...
class  TanhExpression
 Expression class representing the tanh() function. More...
class  TriangularDistribution
 Expression class representing the Triangular distribution. More...
class  TruncateExpression
 Expression class representing the truncate() operator. More...
class  UniformDistribution
 Expression class representing the Uniform distribution. More...
class  UtilityNode
 A UtilityNode represents a utility function. More...
class  WeibullDistribution
 Expression class representing the Weibull distribution. More...

Typedefs

typedef std::vector< Attribute * > AttributeList
 Standard C++ Library container for holding attributes.
typedef std::vector< Class * > ClassList
 Standard C++ Library container for holding Classes.
typedef std::vector< Clique * > CliqueList
 Standard C++ Library container for holding cliques.
typedef std::vector< Expression * > ExpressionList
 Standard C++ Library container for holding expressions.
typedef ptrdiff_t Index
 The type of indexes (for example, a state index).
typedef std::vector
< JunctionTree * > 
JunctionTreeList
 Standard C++ Library container for holding junction trees.
typedef std::vector< Node * > NodeList
 Standard C++ Library container for holding nodes.
typedef float Number
 The type of floating-point numbers used for table data.
typedef std::vector< NumberNumberList
 Standard C++ Library vector of floating-point numbers for holding table data.

Enumerations

enum  Category
 

Node categories.

More...
enum  Constraint
 

Constraints used in structure learning.

More...
enum  Equilibrium
 

Types of equilibrium in the junction trees.

More...
enum  EvidenceMode
 

Modes of propagation.

More...
enum  Kind
 

Node kinds.

More...
enum  Operator
 

Operators to be used in expressions.

More...
enum  TriangulationMethod
 

Triangulation methods.

More...

Detailed Description

The HAPI namespace holds all Hugin C++ API identifiers.


Typedef Documentation

typedef ptrdiff_t HAPI::Index

The type of indexes (for example, a state index).

A negative index indicates a "nonexisting" index.

typedef float HAPI::Number

The type of floating-point numbers used for table data.

If H_DOUBLE is defined, this is double; otherwise, it is float.


Enumeration Type Documentation

Node categories.

H_CATEGORY_CHANCE, H_CATEGORY_DECISION, H_CATEGORY_UTILITY, H_CATEGORY_FUNCTION, H_CATEGORY_INSTANCE.

Constraints used in structure learning.

Before performing structure learning, it is possible to impose constraints on the network to be learned.

H_CONSTRAINT_NONE, H_CONSTRAINT_EDGE_REQUIRED, H_CONSTRAINT_FORWARD_EDGE_REQUIRED, H_CONSTRAINT_BACKWARD_EDGE_REQUIRED, H_CONSTRAINT_EDGE_FORBIDDEN, H_CONSTRAINT_FORWARD_EDGE_FORBIDDEN, H_CONSTRAINT_BACKWARD_EDGE_FORBIDDEN

See also:
Node::setEdgeConstraint ()

Types of equilibrium in the junction trees.

H_EQUILIBRIUM_SUM, H_EQUILIBRIUM_MAX

Modes of propagation.

H_MODE_NORMAL, H_MODE_FAST_RETRACTION

enum HAPI::Kind

Node kinds.

H_KIND_DISCRETE, H_KIND_CONTINUOUS, H_KIND_OTHER

Operators to be used in expressions.

See also:
Expression and sub-classes hereof.

Triangulation methods.

H_TM_CLIQUE_SIZE, H_TM_CLIQUE_WEIGHT, H_TM_FILL_IN_SIZE, H_TM_FILL_IN_WEIGHT, H_TM_BEST_GREEDY, H_TM_TOTAL_WEIGHT

See also:
Domain::triangulate ()

Copyright Hugin Expert A/S 1993-2010