com.cra.figaro.algorithm.factored.factors

Factor

Related Docs: object Factor | package factors

trait Factor[T] extends AnyRef

Definition of 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 type of the Variables they contain and contain a semiring that defines the mathematical operation to be performed on the values Parent variables are distinguished from the output variable.

Refactored by

Linear Supertypes
AnyRef, Any
Known Subclasses
BasicFactor, ConditionalSelector, ConstraintFactor, SparseFactor
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Factor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def combination(that: Factor[T], op: (T, T) ⇒ T): Factor[T]

    Combination function for factors.

    Combination function for factors. By default, this is product, but other operations (such as divide that is a valid operation for some semirings) can use this

  2. abstract def convert[U](semiring: Semiring[U]): Factor[U]

    Creates a new Factor of the same class with a different type and semiring

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

    Creates a new factor of the same type

  4. abstract def deDuplicate(): Factor[T]

    Returns a new Factor with duplicate variable(s) removed

  5. abstract def fillByRule(rule: (List[Extended[_]]) ⇒ T): Factor[T]

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

  6. 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.

  7. abstract def mapTo[U](fn: (T) ⇒ U, _semiring: Semiring[U] = semiring): Factor[U]

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

  8. abstract def marginalizeTo(semiring: Semiring[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. This involves summing out all other variables.

  9. abstract def output: List[Variable[_]]

  10. abstract def parents: List[Variable[_]]

  11. abstract 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 all variables in the two inputs, and the value associated with an assignment is the product of the values in the two inputs.

  12. abstract 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.

  13. abstract def semiring: Semiring[T]

  14. abstract def sumOver(variable: Variable[_]): 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.

  15. abstract def toReadableString: String

    Produce a readable string representation of the 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 contains(index: List[Int]): Boolean

  7. var contents: Map[List[Int], T]

    Attributes
    protected[com.cra.figaro]

  8. def convertIndicesToValues(indices: List[Int]): List[Extended[_]]

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. 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

  13. def generateIndices: Indices

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. def getIndices: Indices

  16. def hasStar: Boolean

    Indicates if any of this Factor's variables has Star

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. val isConstraint: Boolean

    Indicates if this Factor is condition/constrained

  19. def isEmpty: Boolean

    Indicates if this Factor has any variables

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. lazy val numVars: Int

  25. 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.

  26. val size: Int

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. 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

  29. def variables: List[Variable[_]]

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped