t

# DecisionAlgorithm 

#### trait DecisionAlgorithm[T, U] extends Algorithm

Trait that defines some common interface functions for decision algorithms. Every decision algorithm must define the function computeUtility().

Linear Supertypes
Algorithm, AnyRef, Any
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. DecisionAlgorithm
2. Algorithm
3. AnyRef
4. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### Abstract Value Members

1. abstract def computeUtility(): Map[(T, U), DecisionSample]

Compute the utility of each parent/decision tuple and return a DecisionSample.

Compute the utility of each parent/decision tuple and return a DecisionSample. Each decision algorithm must define how this is done since it is used to set the policy for a decision. For sampling algorithms, this will me a map of parent/decision tuples to a utility and a weight for that combination. For factored algorithms, the DecisionSample will contain the exact expected utility with a weight of 1.0.

2. abstract def doKill(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
Algorithm
3. abstract def doResume(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
Algorithm
4. abstract def doStart(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
Algorithm
5. abstract def doStop(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
Algorithm

### Concrete Value Members

1. final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
2. final def ##(): Int
Definition Classes
AnyRef → Any
3. final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
4. val active: Boolean
Attributes
protected
Definition Classes
Algorithm
5. final def asInstanceOf[T0]: T0
Definition Classes
Any
6. def cleanUp(): Unit

Called when the algorithm is killed.

Called when the algorithm is killed. By default, does nothing. Can be overridden.

Definition Classes
Algorithm
7. def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
8. final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
9. def equals(arg0: Any): Boolean
Definition Classes
AnyRef → Any
10. def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
11. final def getClass(): Class[_]
Definition Classes
AnyRef → Any
12. def getUtility(p: T, d: U)

Get the total utility and weight for a specific value of a parent and decision.

13. def getUtility(): Map[(T, U), DecisionSample]

Get the total utility and weight for all sampled values of the parent and decision.

14. def hashCode(): Int
Definition Classes
AnyRef → Any
15. def initialize(): Unit

Called when the algorithm is started before running any steps.

Called when the algorithm is started before running any steps. By default, does nothing. Can be overridden.

Definition Classes
Algorithm
16. def isActive: Boolean
Definition Classes
Algorithm
17. final def isInstanceOf[T0]: Boolean
Definition Classes
Any
18. def kill(): Unit

Kill the algorithm so that it is inactive.

Kill the algorithm so that it is inactive. It will no longer be able to provide answers.Throws AlgorithmInactiveException if the algorithm is not active.

Definition Classes
Algorithm
19. final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
20. final def notify(): Unit
Definition Classes
AnyRef
21. final def notifyAll(): Unit
Definition Classes
AnyRef
22. def resume(): Unit

Resume the computation of the algorithm, if it has been stopped.

Resume the computation of the algorithm, if it has been stopped. Throws AlgorithmInactiveException if the algorithm is not active.

Definition Classes
Algorithm
23. def setPolicy(e: Decision[T, U]): Unit

Sets the policy for the given decision.

Sets the policy for the given decision. This will get the computed utility of the algorithm and call setPolicy on the decision. Note there is no error checking here, so the decision in the argument must match the target decision in the algorithm.

24. def start(): Unit

Start the algorithm and make it active.

Start the algorithm and make it active. After it returns, the algorithm must be ready to provide answers. Throws AlgorithmActiveException if the algorithm is already active.

Definition Classes
Algorithm
25. def stop(): Unit

Stop the algorithm from computing.

Stop the algorithm from computing. The algorithm is still ready to provide answers after it returns. Throws AlgorithmInactiveException if the algorithm is not active.

Definition Classes
Algorithm
26. final def synchronized[T0](arg0: ⇒ T0): T0
Definition Classes
AnyRef
27. def toString(): String
Definition Classes
AnyRef → Any
28. final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )
29. final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )
30. final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )