|
ArgSpec.java
|
/* * Copyright (c) 2005, 2006, Regents of the University of California * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * * Neither the name of the University of California, Berkeley nor * the names of its contributors may be used to endorse or promote * products derived from this software without specific prior * written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. */ package blog; import java.util.*;
Represents an abstract argument specification. In general, an argument
can be:
|
public abstract class ArgSpec {
Returns a List consisting of the objects obtained by evaluating
each element of argSpecs in the given context.
|
public static List evaluate(EvalContext context, List argSpecs) {
List results = new ArrayList();
for (Iterator iter = argSpecs.iterator(); iter.hasNext(); ) {
results.add(((ArgSpec) iter.next()).evaluate(context));
}
return results;
}
| Returns the value of this argument specification in the context. This method raises a fatal error if the partial world in the given context is not complete enough to evaluate this ArgSpec. |
public Object evaluate(PartialWorld w) {
return evaluate(new DefaultEvalContext(w, true));
}
| Returns the value of this argument specification in the given context. Returns null if the partial world in this context is not complete enough to evaluate this ArgSpec, or if this ArgSpec contains a free variable that is not assigned a value in the given context. |
public abstract Object evaluate(EvalContext context);
| Returns true if this ArgSpec contains any random function symbols or any type symbols (any type might have a number statement, and thus could be random). |
public abstract boolean containsRandomSymbol();
| Returns true if the given partial world is complete enough to determine the value of this ArgSpec. |
public boolean isDetermined(PartialWorld w) {
return (evaluate(new DefaultEvalContext(w, false)) != null);
}
| Returns the value of this ArgSpec if it is non-random. Otherwise returns null. |
public Object getValueIfNonRandom() {
return evaluate(new DefaultEvalContext(PartialWorld.EMPTY_INST,
false));
}
| Returns the (basic or derived) random variable that this argument specification corresponds to. Assumes this argument specification contains no free variables. The default implementation just returns a DerivedVar with this ArgSpec. However, some argument specifications (such as function application terms and atomic formulas) may correspond to BasicVars. |
public BayesNetVar getVariable() {
return new DerivedVar(this);
}
Returns true if, within the given scope, all the variables used
in this ArgSpec are in scope and all type constraints are
satisfied. If there is a type or scope error, prints an appropriate
message to standard error and returns false.
|
public abstract boolean checkTypesAndScope(Model model, Map scope);
|
Does compilation steps that can only be done correctly once the
model is complete. Prints messages to standard error if any errors
are encountered. Returns the number of errors encountered.
This default implementation just returns 0. of this method invocation. Ordered by invocation order. Used to detect cycles.
|
public int compile(LinkedHashSet callStack) {
return 0;
}
| Returns true if the value of this ArgSpec is always an instance of Number (regardless of scope). The default implementation returns false. |
public boolean isNumeric() {
return false;
}
| Sets the location of this ArgSpec, for instance, the file name and line number where it appears. The location can be any object whose toString method returns an identifying string that can be used in error messages. |
public void setLocation(Object loc) {
location = loc;
}
| Returns the object specified by the last call to setLocation. If setLocation has not been called, returns the string "(no location)". |
public Object getLocation() {
return location;
}
|
Returns the proper sub-expressions of this ArgSpec. This is an
empty collection if this ArgSpec has no proper sub-expressions.
This default implementation returns an empty collection.
|
public Collection getSubExprs() {
return Collections.EMPTY_LIST;
}
Returns the logical variables that occur free in this expression.
If this expression was loaded from a file, then this method should
be called only after checkTypesAndScope, which
converts SymbolTerms to LogicalVars.
The default implementation returns the union of the sets of free variables in this expression's sub-expressions. SymbolTerm
|
public Set getFreeVars() {
Set freeVars = new HashSet();
for (Iterator iter = getSubExprs().iterator(); iter.hasNext(); ) {
ArgSpec subExpr = (ArgSpec) iter.next();
freeVars.addAll(subExpr.getFreeVars());
}
return Collections.unmodifiableSet(freeVars);
}
Returns the result of applying the given substitution to this
expression. In the result, every free occurrence of a logical
variable x is replaced with
subst.getReplacement(x) (which is just x
itself if subst does not explicitly specify a
replacement).
|
public ArgSpec getSubstResult(Substitution subst) {
Set<LogicalVar> boundVars = Collections.emptySet();
return getSubstResult(subst, boundVars);
}
Returns the result of applying the substitution
subst to this expression, excluding the logical
variables in boundVars. This method is used for
recursive calls. The set boundVars should contain
those variables that are bound in the syntax tree between this
sub-expression and the top-level expression to which the
substitution is being applied.
|
public abstract ArgSpec getSubstResult(Substitution subst,
Set<LogicalVar> boundVars);
private static String DEFAULT_LOCATION = "(no location)";
protected Object location = DEFAULT_LOCATION;
}
This file was generated on Tue Jun 08 17:53:36 PDT 2010 from file ArgSpec.java
by the ilog.language.tools.Hilite Java tool written by Hassan Aït-Kaci