ivory.smrf.model

Class Clique

java.lang.Object

ivory.smrf.model.Clique

Direct Known Subclasses:

CascadeClique, ConstrainedClique

public class Clique
extends Object

A clique in a MRF.

Author:

Don Metzler, Lidan Wang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Clique.MaxScoreComparator Comparator based on the max score of a clique.
static class	Clique.Type

Constructor Summary

Constructors

Constructor and Description
Clique(List<GraphNode> nodes, PotentialFunction f, Parameter weight)
Clique(List<GraphNode> nodes, PotentialFunction f, Parameter param, float importance, Clique.Type type, boolean docDependent)

Method Summary

Methods

Modifier and Type	Method and Description
String	getConcept() Returns a textual representation of the term nodes in this clique.
float	getImportance() Returns the clique-dependent importance.
float	getMaxScore() Returns the max score.
int	getNextCandidate() Returns the next candidate document.
List<GraphNode>	getNodes() Returns nodes in this clique.
Parameter	getParameter() Returns the parameter associated with this clique.
float	getPotential() Returns the potential of this clique.
PotentialFunction	getPotentialFunction() Returns the potential function associated with this clique.
Clique.Type	getType() Returns the clique type.
float	getWeight() Returns the weight associated with this clique
void	initialize(GlobalEvidence globalEvidence) Initializes this clique.
boolean	isDocDependent() Returns whether or not this clique is document dependent.
void	setImportance(float w) Sets the clique-dependent importance.
void	setNextCandidate(int docid) Sets the next candidate for evaluation.
void	setParameterName(String name) Sets the parameter name.
void	setParameterWeight(float weight) Sets the parameter weight.
void	setType(Clique.Type type) Sets the clique type.
String	toString()
String	toString(boolean verbose)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Clique

public Clique(List<GraphNode> nodes,
      PotentialFunction f,
      Parameter weight)

Clique

public Clique(List<GraphNode> nodes,
      PotentialFunction f,
      Parameter param,
      float importance,
      Clique.Type type,
      boolean docDependent)

Method Detail

getConcept

public String getConcept()

Returns a textual representation of the term nodes in this clique.

getImportance

public float getImportance()

Returns the clique-dependent importance.

getMaxScore

public float getMaxScore()

Returns the max score.

getNextCandidate

public int getNextCandidate()

Returns the next candidate document.

getNodes

public List<GraphNode> getNodes()

Returns nodes in this clique.

getParameter

public Parameter getParameter()

Returns the parameter associated with this clique.

getPotential

public float getPotential()

Returns the potential of this clique.

getPotentialFunction

public PotentialFunction getPotentialFunction()

Returns the potential function associated with this clique.

getType

public Clique.Type getType()

Returns the clique type.

getWeight

public float getWeight()

Returns the weight associated with this clique

initialize

public void initialize(GlobalEvidence globalEvidence)
                throws ConfigurationException

Initializes this clique.

Throws:

ConfigurationException

isDocDependent

public boolean isDocDependent()

Returns whether or not this clique is document dependent.

setImportance

public void setImportance(float w)

Sets the clique-dependent importance.

setNextCandidate

public void setNextCandidate(int docid)

Sets the next candidate for evaluation.

setParameterName

public void setParameterName(String name)

Sets the parameter name.

setParameterWeight

public void setParameterWeight(float weight)

Sets the parameter weight.

setType

public void setType(Clique.Type type)

Sets the clique type.

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean verbose)