org.linqs.psl.reasoner.admm.term

Class ADMMTermGenerator

java.lang.Object

org.linqs.psl.reasoner.term.HyperplaneTermGenerator<ADMMObjectiveTerm,LocalVariable>

org.linqs.psl.reasoner.admm.term.ADMMTermGenerator

All Implemented Interfaces:

TermGenerator<ADMMObjectiveTerm,LocalVariable>

public class ADMMTermGenerator
extends HyperplaneTermGenerator<ADMMObjectiveTerm,LocalVariable>

A TermGenerator for ADMM objective terms.

Field Summary

Fields inherited from class org.linqs.psl.reasoner.term.HyperplaneTermGenerator

addDeterTerms, collectiveDeter, deterConstant, deterEpsilon, deterWeight, invertNegativeWeight, mergeConstants

Constructor Summary

Constructors

Constructor and Description
ADMMTermGenerator()
ADMMTermGenerator(boolean mergeConstants)

Method Summary

Modifier and Type	Method and Description
int	createLinearConstraintTerm(Collection<ADMMObjectiveTerm> newTerms, TermStore<ADMMObjectiveTerm,LocalVariable> termStore, GroundRule groundRule, Hyperplane<LocalVariable> hyperplane, FunctionComparator comparator) Create a hard constraint term, and add it to the collection of new terms.
int	createLossTerm(Collection<ADMMObjectiveTerm> newTerms, TermStore<ADMMObjectiveTerm,LocalVariable> termStore, boolean isHinge, boolean isSquared, GroundRule groundRule, Hyperplane<LocalVariable> hyperplane) Create a term from a ground rule and hyperplane, and add it to the collection of new terms.
Class<LocalVariable>	getLocalVariableType() Get the class object for the local variable type.

Methods inherited from class org.linqs.psl.reasoner.term.HyperplaneTermGenerator

createTerm, generateTerms

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ADMMTermGenerator

public ADMMTermGenerator()

ADMMTermGenerator

public ADMMTermGenerator(boolean mergeConstants)

Method Detail

getLocalVariableType

public Class<LocalVariable> getLocalVariableType()

Description copied from class: HyperplaneTermGenerator

Get the class object for the local variable type. This is for type safety when creating hyperplanes.

Specified by:

getLocalVariableType in class HyperplaneTermGenerator<ADMMObjectiveTerm,LocalVariable>

createLossTerm

public int createLossTerm(Collection<ADMMObjectiveTerm> newTerms,
                          TermStore<ADMMObjectiveTerm,LocalVariable> termStore,
                          boolean isHinge,
                          boolean isSquared,
                          GroundRule groundRule,
                          Hyperplane<LocalVariable> hyperplane)

Description copied from class: HyperplaneTermGenerator

Create a term from a ground rule and hyperplane, and add it to the collection of new terms. Non-hinge terms are linear combinations (ala arithmetic rules). Non-squared terms are linear.

Specified by:

createLossTerm in class HyperplaneTermGenerator<ADMMObjectiveTerm,LocalVariable>

Returns:

the number of terms added to the supplied collection.

createLinearConstraintTerm

public int createLinearConstraintTerm(Collection<ADMMObjectiveTerm> newTerms,
                                      TermStore<ADMMObjectiveTerm,LocalVariable> termStore,
                                      GroundRule groundRule,
                                      Hyperplane<LocalVariable> hyperplane,
                                      FunctionComparator comparator)

Description copied from class: HyperplaneTermGenerator

Create a hard constraint term, and add it to the collection of new terms.

Specified by:

createLinearConstraintTerm in class HyperplaneTermGenerator<ADMMObjectiveTerm,LocalVariable>

Returns:

the number of terms added to the supplied collection.