rvl.stat.anova
Class Factor

java.lang.Object
  |
  +--rvl.stat.anova.Term
        |
        +--rvl.stat.anova.Factor
Direct Known Subclasses:
WithinCells

public class Factor
extends Term

Factor class

See Also:

Field Summary
protected  int levels
           
protected  java.lang.String name
           
protected  boolean random
           
protected  FactorSet siblings
           
 
Fields inherited from class rvl.stat.anova.Term
fac, fullName, nestedIn
 
Constructor Summary
Factor()
           
Factor(java.lang.String Name, int Levels, boolean Random)
          Construct a Factor object
Factor(java.lang.String Name, int Levels, int nNest)
          Construct a Factor nested in one or more other factors.
Factor(java.lang.String Name, int Levels, Term Nest)
          Construct a Factor nested in one or more other factors.
 
Method Summary
 boolean contains(Factor f)
           
 Factor factor(int i)
          Overrides Term method
 int getLevels()
           
 java.lang.String getName()
           
 java.lang.String getShortName()
           
 boolean isRandom()
          Overrides Term method
 int order()
          Overrides Term method
 void setLevels(int k)
           
 void setName(java.lang.String s)
           
 void setRandom(boolean r)
           
 
Methods inherited from class rvl.stat.anova.Term
containsFactor, containsTerm, df, getFactors, getNest, minus, overlaps, overlaps, setNest, span, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

levels

protected int levels

random

protected boolean random

siblings

protected FactorSet siblings
Constructor Detail

Factor

public Factor()

Factor

public Factor(java.lang.String Name,
              int Levels,
              boolean Random)
Construct a Factor object
Parameters:
Name - name of factor
Levels - number of levels
Random - true if levels are random, false if levels are fixed

Factor

public Factor(java.lang.String Name,
              int Levels,
              Term Nest)
Construct a Factor nested in one or more other factors. (Note: Object is initialized as a random factor.)
Parameters:
Name - name of factor
Levels - number of levels
Nest - a Term object containing the nesting factors

Factor

public Factor(java.lang.String Name,
              int Levels,
              int nNest)
Construct a Factor nested in one or more other factors. (Note: Object is initialized as a random factor.)
Parameters:
Name - name of factor
Levels - number of levels
nNest - number of factors in its nest
Method Detail

setName

public void setName(java.lang.String s)

getName

public java.lang.String getName()
Overrides:
getName in class Term
Following copied from class: rvl.stat.anova.Term
Returns:
the full name of the term

getShortName

public java.lang.String getShortName()

setLevels

public void setLevels(int k)

getLevels

public int getLevels()

order

public int order()
Overrides Term method
Overrides:
order in class Term
Following copied from class: rvl.stat.anova.Term
Returns:
the number of interacting factors (not counting nests)

factor

public Factor factor(int i)
Overrides Term method
Overrides:
factor in class Term
Following copied from class: rvl.stat.anova.Term
Returns:
the factor at index i

setRandom

public void setRandom(boolean r)

isRandom

public boolean isRandom()
Overrides Term method
Overrides:
isRandom in class Term
Following copied from class: rvl.stat.anova.Term
Returns:
whether or not the term contains random factors

contains

public boolean contains(Factor f)
Returns:
true if f is equal to this factor or is in or contained in this factor's nest