Gephi Toolkit Javadoc

org.gephi.data.attributes.type
Class DynamicFloat

java.lang.Object
  extended by org.gephi.data.attributes.type.DynamicType<java.lang.Float>
      extended by org.gephi.data.attributes.type.DynamicFloat

public final class DynamicFloat
extends DynamicType<java.lang.Float>

Represents Float type which can have got different values in different time intervals.

Author:
Cezary Bartosiak

Field Summary
 
Fields inherited from class org.gephi.data.attributes.type.DynamicType
intervalTree
 
Constructor Summary
DynamicFloat()
          Constructs a new DynamicType instance with no intervals.
DynamicFloat(DynamicFloat source)
          Constructs a deep copy of source.
DynamicFloat(DynamicFloat source, Interval<java.lang.Float> in)
          Constructs a deep copy of source that contains a given Interval<T> in.
DynamicFloat(DynamicFloat source, Interval<java.lang.Float> in, Interval<java.lang.Float> out)
          Constructs a deep copy of source that contains a given Interval<T> in.
DynamicFloat(DynamicFloat source, java.util.List<Interval<java.lang.Float>> in)
          Constructs a deep copy of source with additional intervals given by List<Interval<T>> in.
DynamicFloat(DynamicFloat source, java.util.List<Interval<java.lang.Float>> in, java.util.List<Interval<java.lang.Float>> out)
          Constructs a deep copy of source with additional intervals given by List<Interval<T>> in.
DynamicFloat(Interval<java.lang.Float> in)
          Constructs a new DynamicType instance that contains a given Interval<T> in.
DynamicFloat(java.util.List<Interval<java.lang.Float>> in)
          Constructs a new DynamicType instance with intervals given by List<Interval<T>> in.
 
Method Summary
 java.lang.Class getUnderlyingType()
          Returns the underlying type T.
 java.lang.Float getValue(Interval interval, Estimator estimator)
          Returns the estimated value of a set of values whose time intervals overlap with a given time interval.
 
Methods inherited from class org.gephi.data.attributes.type.DynamicType
equals, getHigh, getIntervals, getIntervals, getIntervals, getLow, getValue, getValue, getValue, getValue, getValue, getValues, getValues, getValues, hashCode, isHighExcluded, isInRange, isInRange, isLowExcluded, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DynamicFloat

public DynamicFloat()
Constructs a new DynamicType instance with no intervals.


DynamicFloat

public DynamicFloat(Interval<java.lang.Float> in)
Constructs a new DynamicType instance that contains a given Interval<T> in.

Parameters:
in - interval to add (could be null)

DynamicFloat

public DynamicFloat(java.util.List<Interval<java.lang.Float>> in)
Constructs a new DynamicType instance with intervals given by List<Interval<T>> in.

Parameters:
in - intervals to add (could be null)

DynamicFloat

public DynamicFloat(DynamicFloat source)
Constructs a deep copy of source.

Parameters:
source - an object to copy from (could be null, then completely new instance is created)

DynamicFloat

public DynamicFloat(DynamicFloat source,
                    Interval<java.lang.Float> in)
Constructs a deep copy of source that contains a given Interval<T> in.

Parameters:
source - an object to copy from (could be null, then completely new instance is created)
in - interval to add (could be null)

DynamicFloat

public DynamicFloat(DynamicFloat source,
                    Interval<java.lang.Float> in,
                    Interval<java.lang.Float> out)
Constructs a deep copy of source that contains a given Interval<T> in. Before add it removes from the newly created object all intervals that overlap with a given Interval<T> out.

Parameters:
source - an object to copy from (could be null, then completely new instance is created)
in - interval to add (could be null)
out - interval to remove (could be null)

DynamicFloat

public DynamicFloat(DynamicFloat source,
                    java.util.List<Interval<java.lang.Float>> in)
Constructs a deep copy of source with additional intervals given by List<Interval<T>> in.

Parameters:
source - an object to copy from (could be null, then completely new instance is created)
in - intervals to add (could be null)

DynamicFloat

public DynamicFloat(DynamicFloat source,
                    java.util.List<Interval<java.lang.Float>> in,
                    java.util.List<Interval<java.lang.Float>> out)
Constructs a deep copy of source with additional intervals given by List<Interval<T>> in. Before add it removes from the newly created object all intervals that overlap with intervals given by List<Interval<T>> out.

Parameters:
source - an object to copy from (could be null, then completely new instance is created)
in - intervals to add (could be null)
out - intervals to remove (could be null)
Method Detail

getValue

public java.lang.Float getValue(Interval interval,
                                Estimator estimator)
Description copied from class: DynamicType
Returns the estimated value of a set of values whose time intervals overlap with a given time interval.

Specified by:
getValue in class DynamicType<java.lang.Float>
Parameters:
interval - a given time interval
estimator - used to estimate the result
Returns:
the estimated value of a set of values whose time intervals overlap with a given time interval or null if there are no intervals.
See Also:
Estimator

getUnderlyingType

public java.lang.Class getUnderlyingType()
Description copied from class: DynamicType
Returns the underlying type T.

Specified by:
getUnderlyingType in class DynamicType<java.lang.Float>
Returns:
the underlying type T.

Gephi Toolkit Javadoc