edu.umd.cs.psl.model

Class Model

java.lang.Object

edu.umd.cs.psl.model.Model

public class Model
extends Object

A probabilistic soft logic model.

Encapsulates a set of Kernels. A ModelApplication can be used to combine a Model with data to perform inference or learn.

Objects which use a Model should register with it to listen for ModelEvents.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Kernel>	kernels
protected Set<Kernel>	kernelSet Redundant set for fast membership checks
protected Set<ModelEvent.Listener>	modelObservers

Constructor Summary

Constructors

Constructor and Description
Model() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKernel(Kernel k) Adds a Kernel to this Model.
protected void	broadcastModelEvent(ModelEvent event)
Iterable<Kernel>	getKernels()
void	notifyKernelParametersModified(Kernel k) Notifies this Model that a Kernel's parameters were modified.
void	registerModelObserver(ModelEvent.Listener observer) Registers an observer to receive ModelEvents.
void	removeKernel(Kernel k) Removes a Kernel from this Model.
String	toString() Returns a String representation of this Model.
void	unregisterModelObserver(ModelEvent.Listener observer) Unregisters an observer so it will no longer receive ModelEvents from this model.

Methods inherited from class java.lang.Object

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

Field Detail

kernels

protected final List<Kernel> kernels

kernelSet

protected final Set<Kernel> kernelSet

Redundant set for fast membership checks

modelObservers

protected final Set<ModelEvent.Listener> modelObservers

Constructor Detail

Model

public Model()

Sole constructor.

Method Detail

registerModelObserver

public void registerModelObserver(ModelEvent.Listener observer)

Registers an observer to receive ModelEvents.

Parameters:

observer - object to notify of events

unregisterModelObserver

public void unregisterModelObserver(ModelEvent.Listener observer)

Unregisters an observer so it will no longer receive ModelEvents from this model.

Parameters:

observer - object to stop notifying

getKernels

public Iterable<Kernel> getKernels()

Returns:

the Kernels contained in this model

addKernel

public void addKernel(Kernel k)

Adds a Kernel to this Model.

All observers of this Model will receive a ModelEvent#KernelAdded event.

Parameters:

k - Kernel to add

Throws:

IllegalArgumentException - if the Kernel is already in this Model

removeKernel

public void removeKernel(Kernel k)

Removes a Kernel from this Model.

All observers of this Model will receive a ModelEvent#KernelRemoved event.

Parameters:

k - Kernel to remove

Throws:

IllegalArgumentException - if the Kernel is not in this Model

notifyKernelParametersModified

public void notifyKernelParametersModified(Kernel k)

Notifies this Model that a Kernel's parameters were modified.

All observers of this model will receive a ModelEvent#KernelParametersModified event.

Parameters:

k - the Kernel that was modified

Throws:

IllegalArgumentException - if the Kernel is not in this Model

toString

public String toString()

Returns a String representation of this Model.

The String will start with "Model:", followed by a newline, then the String representations of each Kernel in this Model (each followed by a newline). Constraint Kernels will come before compatibility kernels.

Overrides:

toString in class Object

Returns:

the String representation

See Also:

Kernel#isCompatibilityKernel()

broadcastModelEvent

protected void broadcastModelEvent(ModelEvent event)