edu.illinois.cs.cogcomp.lbjava.classify

Class DiscreteReferrer

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.classify.Feature

edu.illinois.cs.cogcomp.lbjava.classify.DiscreteFeature

edu.illinois.cs.cogcomp.lbjava.classify.DiscreteReferrer

All Implemented Interfaces:

Serializable, Cloneable, Comparable

Direct Known Subclasses:

DiscreteReferringFeature, DiscreteReferringStringFeature

public abstract class DiscreteReferrer
extends DiscreteFeature

A referring discrete feature is one that has its own identifier, but whose value comes from a separate feature that it refers to.

Author:

Nick Rizzolo

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DiscreteFeature	referent The feature being referred to.

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.classify.DiscreteFeature

BooleanValues, totalValues, valueIndex

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.classify.Feature

containingPackage, generatingClassifier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiscreteReferrer() For internal use only.
	DiscreteReferrer(Classifier c, DiscreteFeature r) Sets both the identifier and the referent.
	DiscreteReferrer(Classifier c, DiscreteFeature r, String[] av) Sets both the identifier and the referent.
	DiscreteReferrer(String p, String c, DiscreteFeature r, short vi, short t) Constructs a new referring feature.

Method Summary

Modifier and Type	Method and Description
int	childLexiconLookup(ChildLexicon lex, int label) Does a feature-type-specific lookup of this feature in the given ChildLexicon.
int	compareTo(Object o) Used to sort features into an order that is convenient both to page through and for the lexicon to read off disk.
int	depth() The depth of a feature is one more than the maximum depth of any of its children, or 0 if it has no children.
ByteString	getByteStringValue() Gives a string representation of the value of this feature.
DiscreteFeature	getReferent() Returns the value of referent.
String	getStringValue() Gives a string representation of the value of this feature.
int	hashCode() The hash code of a DiscreteReferrer is the sum of the hash codes of its containing package, identifier, and the referent feature.
boolean	isReferrer() Determines if this feature is a referring feature.
void	lexRead(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in, Lexicon lex, String p, String g, String si, ByteString bi) Reads the representation of a feature with this object's run-time type as stored by a lexicon, overwriting the data in this object.
String	lexWrite(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out, Lexicon lex, String c, String p, String g, String si, ByteString bi) Writes a binary representation of the feature intended for use by a lexicon, omitting redundant information when possible.
void	read(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in) Reads the representation of a feaeture with this object's run-time type from the given stream, overwriting the data in this object.
void	removeFromChildLexicon(ChildLexicon lex) Takes care of any feature-type-specific tasks that need to be taken care of when removing a feature of this type from a ChildLexicon, in particular updating parent counts and removing children of this feature if necessary.
boolean	valueEquals(String v) Determines whether or not the parameter is equivalent to the string representation of the value of this feature.
void	write(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out) Writes a complete binary representation of the feature.
void	write(StringBuffer buffer) Writes a string representation of this Feature to the specified buffer.
void	writeNoPackage(StringBuffer buffer) Writes a string representation of this Feature to the specified buffer, omitting the package name.

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.classify.DiscreteFeature

conjunction, conjunctWith, getStrength, getValueIndex, isDiscrete, totalValues

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.classify.Feature

classEquivalent, clone, compareNameStrings, conjunctWith, encode, equals, fromArray, getByteStringIdentifier, getFeatureKey, getFeatureKey, getGeneratingClassifier, getPackage, getStringIdentifier, hasByteStringIdentifier, hasStringIdentifier, isConjunctive, isPrimitive, lexReadFeature, makeReal, readFeature, setArrayLength, toString, toStringNoPackage, withStrength, writeNameString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

referent

protected DiscreteFeature referent

The feature being referred to.

Constructor Detail

DiscreteReferrer

protected DiscreteReferrer()

For internal use only.

See Also:

Feature.readFeature(ExceptionlessInputStream)

DiscreteReferrer

public DiscreteReferrer(Classifier c,
                        DiscreteFeature r)

Sets both the identifier and the referent.

Parameters:

c - The classifier that produced this feature.

r - The discrete feature referred to by this new feature.

DiscreteReferrer

public DiscreteReferrer(Classifier c,
                        DiscreteFeature r,
                        String[] av)

Sets both the identifier and the referent.

Parameters:

c - The classifier that produced this feature.

r - The discrete feature referred to by this new feature.

av - The allowable values of the classifier that produced r.

DiscreteReferrer

public DiscreteReferrer(String p,
                        String c,
                        DiscreteFeature r,
                        short vi,
                        short t)

Constructs a new referring feature.

Parameters:

p - The new discrete feature's package.

c - The name of the classifier that produced this feature.

r - The discrete feature referred to by this new feature.

vi - The index corresponding to the value.

t - The total allowable values for this feature.

Method Detail

isReferrer

public boolean isReferrer()

Determines if this feature is a referring feature.

Overrides:

isReferrer in class Feature

Returns:

true iff this feature is a referring feature.

getReferent

public DiscreteFeature getReferent()

Returns the value of referent.

depth

public int depth()

The depth of a feature is one more than the maximum depth of any of its children, or 0 if it has no children.

Overrides:

depth in class Feature

Returns:

The depth of this feature as described above.

getStringValue

public String getStringValue()

Gives a string representation of the value of this feature.

Specified by:

getStringValue in class Feature

Returns:

Whatever is returned by this method on referent.

getByteStringValue

public ByteString getByteStringValue()

Gives a string representation of the value of this feature.

Specified by:

getByteStringValue in class Feature

Returns:

Whatever is returned by this method on referent.

valueEquals

public boolean valueEquals(String v)

Determines whether or not the parameter is equivalent to the string representation of the value of this feature.

Specified by:

valueEquals in class Feature

Parameters:

v - The string to compare against.

Returns:

true iff v is equivalent to the string representation of the value of this feature.

removeFromChildLexicon

public void removeFromChildLexicon(ChildLexicon lex)

Takes care of any feature-type-specific tasks that need to be taken care of when removing a feature of this type from a ChildLexicon, in particular updating parent counts and removing children of this feature if necessary.

Overrides:

removeFromChildLexicon in class Feature

Parameters:

lex - The child lexicon this feature is being removed from.

childLexiconLookup

public int childLexiconLookup(ChildLexicon lex,
                              int label)

Does a feature-type-specific lookup of this feature in the given ChildLexicon.

Overrides:

childLexiconLookup in class Feature

Parameters:

lex - The child lexicon this feature is being looked up in.

label - The label of the example containing this feature, or -1 if we aren't doing per class feature counting.

Returns:

The index of f in this lexicon.

hashCode

public int hashCode()

The hash code of a DiscreteReferrer is the sum of the hash codes of its containing package, identifier, and the referent feature.

Overrides:

hashCode in class Feature

Returns:

The hash code of this feature.

compareTo

public int compareTo(Object o)

Used to sort features into an order that is convenient both to page through and for the lexicon to read off disk.

Specified by:

compareTo in interface Comparable

Specified by:

compareTo in class Feature

Parameters:

o - An object to compare with.

Returns:

Integers appropriate for sorting features first by package, then by identifier, then by value.

write

public void write(StringBuffer buffer)

Writes a string representation of this Feature to the specified buffer.

Specified by:

write in class Feature

Parameters:

buffer - The buffer to write to.

writeNoPackage

public void writeNoPackage(StringBuffer buffer)

Writes a string representation of this Feature to the specified buffer, omitting the package name.

Overrides:

writeNoPackage in class Feature

Parameters:

buffer - The buffer to write to.

write

public void write(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out)

Writes a complete binary representation of the feature.

Overrides:

write in class DiscreteFeature

Parameters:

out - The output stream.

read

public void read(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)

Reads the representation of a feaeture with this object's run-time type from the given stream, overwriting the data in this object.

Overrides:

read in class DiscreteFeature

Parameters:

in - The input stream.

lexWrite

public String lexWrite(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out,
                       Lexicon lex,
                       String c,
                       String p,
                       String g,
                       String si,
                       ByteString bi)

Writes a binary representation of the feature intended for use by a lexicon, omitting redundant information when possible.

Overrides:

lexWrite in class DiscreteFeature

Parameters:

out - The output stream.

lex - The lexicon out of which this feature is being written.

c - The fully qualified name of the assumed class. The runtime class of this feature won't be written if it's equivalent to c.

p - The assumed package string. This feature's package string won't be written if it's equivalent to p.

g - The assumed classifier name string. This feature's classifier name string won't be written if it's equivalent to g.

si - The assumed identifier as a string. If this feature has a string identifier, it won't be written if it's equivalent to si.

bi - The assumed identifier as a byte string. If this feature has a byte string identifier, it won't be written if it's equivalent to bi.

Returns:

The name of the runtime type of this feature.

lexRead

public void lexRead(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in,
                    Lexicon lex,
                    String p,
                    String g,
                    String si,
                    ByteString bi)

Reads the representation of a feature with this object's run-time type as stored by a lexicon, overwriting the data in this object.

This method is appropriate for reading features as written by lexWrite(ExceptionlessOutputStream,Lexicon,String,String,String,String,ByteString).

Overrides:

lexRead in class DiscreteFeature

Parameters:

in - The input stream.

lex - The lexicon we are reading in to.

p - The assumed package string. If no package name is given in the input stream, the instantiated feature is given this package.

g - The assumed classifier name string. If no classifier name is given in the input stream, the instantiated feature is given this classifier name.

si - The assumed identifier as a string. If the feature being read has a string identifier field and no identifier is given in the input stream, the feature is given this identifier.

bi - The assumed identifier as a byte string. If the feature being read has a byte string identifier field and no identifier is given in the input stream, the feature is given this identifier.