t

# BasicFactor 

#### trait BasicFactor[T] extends Factor[T]

Trait for a common implementation of Factors. BasicFactor is still a trait because it does not yet define the underlying data store of the factor

A factor is associated with a set of variables and specifies a value for every combination of assignments to those variables. Factors are parameterized by the types of values they contain.

Linear Supertypes
Factor[T], AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. BasicFactor
2. Factor
3. AnyRef
4. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### Abstract Value Members

1. abstract def contentsContains(index: List[Int]): Boolean

Test whether a factor contains a value for a specific index

Test whether a factor contains a value for a specific index

Definition Classes
Factor
2. abstract def createFactor[T](parents: List[Variable[_]], output: List[Variable[_]], _semiring: Semiring[T] = semiring): Factor[T]

Creates a new factor of the same type

Creates a new factor of the same type

Definition Classes
Factor
3. abstract def get(indices: List[Int]): T

Get the value associated with a row.

Get the value associated with a row. The row is identified by an list of indices into the ranges of the variables over which the factor is defined.

Definition Classes
Factor
4. abstract def getContents(): Traversable[T]

Get the contents of a factor as a traversable (note: no indicies provided)

Get the contents of a factor as a traversable (note: no indicies provided)

Definition Classes
Factor
5. abstract def output: List[Variable[_]]
Definition Classes
Factor
6. abstract def parents: List[Variable[_]]
Definition Classes
Factor
7. abstract val semiring: Semiring[T]
Definition Classes
BasicFactorFactor
8. abstract def set(indices: List[Int], value: T): Factor[T]

Set the value associated with a row.

Set the value associated with a row. The row is identified by an list of indices into the ranges of the variables over which the factor is defined.

Definition Classes
Factor
9. abstract def stringContents(): String

Return the contents of a factor as a string

Return the contents of a factor as a string

Definition Classes
Factor

### 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. final def asInstanceOf[T0]: T0
Definition Classes
Any
5. def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
6. def combination(that: Factor[T], op: (T, T) ⇒ T): Factor[T]

produces a new Factor from the combined input variables of the input factors.

produces a new Factor from the combined input variables of the input factors.

The factor values are computed using the corresponding values from the input factors. This correspondence is determined by the indices of the input factors that overlap with each of the indices of the result factor

that

The Factor to combine with this one

op

The operation used to combine (multiply) factor values

returns

The new Factor containing the combined values of the inputs

Definition Classes
BasicFactorFactor
7. def contains(index: List[Int]): Boolean
Definition Classes
Factor
8. def convertIndicesToValues(indices: List[Int]): List[Extended[_]]
Definition Classes
Factor
9. def deDuplicate(): Factor[T]

Returns a new Factor with duplicate variable(s) removed

Returns a new Factor with duplicate variable(s) removed

Definition Classes
BasicFactorFactor
10. final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
11. def equals(arg0: Any): Boolean
Definition Classes
AnyRef → Any
12. def fillByRule(rule: (List[Extended[_]]) ⇒ T): Factor[T]

Fill the contents of this factor by applying a rule to every combination of parent and output values.

Fill the contents of this factor by applying a rule to every combination of parent and output values.

Definition Classes
BasicFactorFactor
13. def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
14. def foldLeft(initial: T, fn: (T, T) ⇒ T): T

Fold the given function through the contents of the factor, beginning with the given initial values

Fold the given function through the contents of the factor, beginning with the given initial values

Definition Classes
Factor
15. def generateIndices
Definition Classes
Factor
16. final def getClass(): Class[_]
Definition Classes
AnyRef → Any
17. def getIndices
Definition Classes
Factor
18. def hasStar: Boolean

Indicates if any of this Factor's variables has Star

Indicates if any of this Factor's variables has Star

Definition Classes
Factor
19. def hashCode(): Int
Definition Classes
AnyRef → Any
20. val isConstraint: Boolean

Indicates if this Factor is condition/constrained

Indicates if this Factor is condition/constrained

Definition Classes
Factor
21. def isEmpty: Boolean

Indicates if this Factor has any variables

Indicates if this Factor has any variables

Definition Classes
Factor
22. final def isInstanceOf[T0]: Boolean
Definition Classes
Any
23. def mapTo[U](fn: (T) ⇒ U, _semiring: Semiring[U] = semiring): Factor[U]

Convert the contents of the target by applying the given function to all elements of this factor.

Convert the contents of the target by applying the given function to all elements of this factor.

Definition Classes
BasicFactorFactor
24. def marginalizeTo(targets: Variable[_]*): Factor[T]

Returns the marginalization of the factor to a variable according to the addition function in this factor's semiring.

Returns the marginalization of the factor to a variable according to the addition function in this factor's semiring. This involves summing out all other variables.

Definition Classes
Factor
25. def marginalizeToWithSum(sum: (T, T) ⇒ T, targets: Variable[_]*): Factor[T]

Returns the marginalization of the factor to a variable according to the given addition function.

Returns the marginalization of the factor to a variable according to the given addition function. Unlike marginalizeTo, this uses the provided sum function. This is useful e.g. to easily switch between max-product and sum-product operations when the data within are unchanged and the product operation is the same.

The returned factor uses the semiring associated with this factor; it does not override the sum function of the semiring with the function given here.

Definition Classes
BasicFactorFactor
26. final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
27. final def notify(): Unit
Definition Classes
AnyRef
28. final def notifyAll(): Unit
Definition Classes
AnyRef
29. lazy val numVars: Int
Definition Classes
Factor
30. def product(that: Factor[T]): Factor[T]

returns the product of this factor with another factor according to a given multiplication function.

returns the product of this factor with another factor according to a given multiplication function. The product is associated with the combined variables of the two inputs, and the value associated with an assignment is the product of the values in the two inputs.

Definition Classes
BasicFactorFactor
31. def recordArgMax[U](variable: Variable[U], comparator: (T, T) ⇒ Boolean, _semiring: Semiring[U] = semiring.asInstanceOf[Semiring[U]]): Factor[U]

Returns a factor that maps values of the other variables to the value of the given variable that maximizes the entry associated with that value, according to some maximization function.

Returns a factor that maps values of the other variables to the value of the given variable that maximizes the entry associated with that value, according to some maximization function. comparator defines the maximization. It returns true iff its second argument is greater than its first.

U

The type of element whose value is being recorded. The resulting factor maps values of other variables in this factor to this type.

Definition Classes
BasicFactorFactor
32. val size: Int
Definition Classes
Factor
33. def sumOver(variable: Variable[_], sum: (T, T) ⇒ T = semiring.sum): Factor[T]

Returns the summation of the factor over a variable according to an addition function.

Returns the summation of the factor over a variable according to an addition function. The result is associated with all the variables in the input except for the summed over variable and the value for a set of assignments is the sum of the values of the corresponding assignments in the input.

If no funciton is provided, this defaults to the sum function in this factor's semiring.

Definition Classes
BasicFactorFactor
34. final def synchronized[T0](arg0: ⇒ T0): T0
Definition Classes
AnyRef

Produce a readable string representation of the factor

Produce a readable string representation of the factor

Definition Classes
BasicFactorFactor
36. def toString(): String

Description that includes the variable list and conditional probabilities

Description that includes the variable list and conditional probabilities

Definition Classes
Factor → AnyRef → Any
37. def unionVars[U](that: Factor[U]): (List[Variable[_]], List[Variable[_]], List[Int], List[Int])

takes the variables in two factors and produces their set union.

takes the variables in two factors and produces their set union.

It produces a mapping from each original variable to its new location. Similarly it produces a mapping from each new variable to its new location.

38. def variables: List[Variable[_]]
Definition Classes
Factor
39. final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )
40. final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )
41. final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )