edu.rice.cs.hpc.data.experiment.metric.MetricValue Class Reference

A value of a metric at some scope. More...

Collaboration diagram for edu.rice.cs.hpc.data.experiment.metric.MetricValue:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MetricValue ()
 MetricValue (double value, double annotation)
 MetricValue (double value)
float getValue ()
String toString ()
MetricValue duplicate ()

Static Public Member Functions

static void setAnnotationAvailable (MetricValue m, boolean status)
static boolean isAvailable (MetricValue m)
static float getValue (MetricValue m)
static void setValue (MetricValue m, double value)
static boolean isAnnotationAvailable (MetricValue m)
static float getAnnotationValue (MetricValue m)
static void setAnnotationValue (MetricValue m, double annotation)
static void setAnnotationValue (MetricValue m, float annotation)
static boolean isZero (MetricValue m)
static int compareTo (MetricValue left, MetricValue right)

Static Public Attributes

static final MetricValue NONE = new MetricValue(-1)
 The distinguished metric value indicating no data.

Protected Attributes

float value
 The actual value if available.
float annotation
 The annotation value if available.
byte flags

Static Protected Attributes

static final byte VALUE_IS_AVAILABLE = 1
static final byte ANNOTATION_IS_AVAILABLE = 2

Static Private Member Functions

static boolean getAvailable (MetricValue m)
static void setAvailable (MetricValue m, boolean status)
static boolean getAnnotationAvailable (MetricValue m)

Detailed Description

A value of a metric at some scope.

Definition at line 34 of file MetricValue.java.

Constructor & Destructor Documentation

edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue (  ) 

Definition at line 65 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAvailable().

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.duplicate().

edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue ( double  value,
double  annotation 
)

Definition at line 78 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setValue().

edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue ( double  value  ) 

Definition at line 91 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAvailable(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setValue().

Member Function Documentation

static int edu.rice.cs.hpc.data.experiment.metric.MetricValue.compareTo ( MetricValue  left,
MetricValue  right 
) [static]

Definition at line 242 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.

Referenced by edu.rice.cs.hpc.viewer.scope.ColumnViewerSorter.doCompare().

MetricValue edu.rice.cs.hpc.data.experiment.metric.MetricValue.duplicate (  ) 

Definition at line 276 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.annotation, edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags, edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.

Referenced by edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.mergeMetrics().

static boolean edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAnnotationAvailable ( MetricValue  m  )  [static, private]

Definition at line 124 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.ANNOTATION_IS_AVAILABLE, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAnnotationAvailable().

static float edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAnnotationValue ( MetricValue  m  )  [static]

Definition at line 200 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.annotation.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.copyMetrics(), and edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.getAnnotationValue().

static boolean edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAvailable ( MetricValue  m  )  [static, private]

Definition at line 108 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.VALUE_IS_AVAILABLE.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAvailable().

static float edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue ( MetricValue  m  )  [static]

Definition at line 163 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue().

float edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue (  ) 

Definition at line 140 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags, edu.rice.cs.hpc.data.experiment.metric.MetricValue.value, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.VALUE_IS_AVAILABLE.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetric(), edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetricValue(), edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.CompareScope.compare(), edu.rice.cs.hpc.data.experiment.Experiment.copyMetric(), edu.rice.cs.hpc.data.experiment.scope.Scope.copyMetrics(), edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.disseminateMetric(), edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getHotCallPath(), edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue(), edu.rice.cs.hpc.data.experiment.metric.MetricVarMap.getValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.mergeMetrics(), edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.mergeMetricToParent(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.setMetrics(), edu.rice.cs.hpc.data.experiment.scope.visitors.DerivedPercentVisitor.setPercent(), and edu.rice.cs.hpc.data.experiment.scope.visitors.PercentScopeVisitor.setPercentValue().

static boolean edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAnnotationAvailable ( MetricValue  m  )  [static]

Definition at line 188 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAnnotationAvailable(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.NONE.

static boolean edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAvailable ( MetricValue  m  )  [static]

Definition at line 151 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.NONE, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.

Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.mergeMetrics(), and edu.rice.cs.hpc.data.experiment.merge.MergeMetric.setMetrics().

static boolean edu.rice.cs.hpc.data.experiment.metric.MetricValue.isZero ( MetricValue  m  )  [static]

Definition at line 226 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.NONE, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.

static void edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable ( MetricValue  m,
boolean  status 
) [static]

Definition at line 130 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.ANNOTATION_IS_AVAILABLE, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationValue().

static void edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationValue ( MetricValue  m,
float  annotation 
) [static]

Definition at line 219 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.annotation, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable().

static void edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationValue ( MetricValue  m,
double  annotation 
) [static]

Definition at line 212 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.annotation, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable().

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue().

static void edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAvailable ( MetricValue  m,
boolean  status 
) [static, private]

Definition at line 114 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.VALUE_IS_AVAILABLE.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setValue().

static void edu.rice.cs.hpc.data.experiment.metric.MetricValue.setValue ( MetricValue  m,
double  value 
) [static]

Definition at line 175 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAvailable(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.

Referenced by edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.disseminateMetric(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.MetricValue().

String edu.rice.cs.hpc.data.experiment.metric.MetricValue.toString (  ) 

Definition at line 266 of file MetricValue.java.

References edu.rice.cs.hpc.data.experiment.metric.MetricValue.annotation, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.

Member Data Documentation

float edu.rice.cs.hpc.data.experiment.metric.MetricValue.annotation [protected]

The annotation value if available.

Definition at line 41 of file MetricValue.java.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.duplicate(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAnnotationValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.toString().

final byte edu.rice.cs.hpc.data.experiment.metric.MetricValue.ANNOTATION_IS_AVAILABLE = 2 [static, protected]

Definition at line 46 of file MetricValue.java.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAnnotationAvailable(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable().

byte edu.rice.cs.hpc.data.experiment.metric.MetricValue.flags [protected]

Definition at line 43 of file MetricValue.java.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.duplicate(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAnnotationAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationAvailable(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAvailable().

final MetricValue edu.rice.cs.hpc.data.experiment.metric.MetricValue.NONE = new MetricValue(-1) [static]

The distinguished metric value indicating no data.

Definition at line 49 of file MetricValue.java.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetric(), edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetricValue(), edu.rice.cs.hpc.data.experiment.scope.Scope.backupMetricValues(), edu.rice.cs.hpc.data.experiment.Experiment.copyMetric(), edu.rice.cs.hpc.data.experiment.scope.Scope.copyMetrics(), edu.rice.cs.hpc.data.experiment.scope.Scope.getCombinedValues(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue(), edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAnnotationAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.isZero(), edu.rice.cs.hpc.data.experiment.scope.Scope.makeMetricValueArray(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.mergeMetrics(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.setMetrics(), edu.rice.cs.hpc.data.experiment.scope.visitors.DerivedPercentVisitor.setPercent(), edu.rice.cs.hpc.data.experiment.scope.visitors.PercentScopeVisitor.setPercentValue(), and edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.setScopeValue().

float edu.rice.cs.hpc.data.experiment.metric.MetricValue.value [protected]

The actual value if available.

Definition at line 38 of file MetricValue.java.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.compareTo(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.isZero(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.setValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.toString().

final byte edu.rice.cs.hpc.data.experiment.metric.MetricValue.VALUE_IS_AVAILABLE = 1 [static, protected]

Definition at line 45 of file MetricValue.java.

Referenced by edu.rice.cs.hpc.data.experiment.metric.MetricValue.getAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue(), and edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAvailable().

The documentation for this class was generated from the following file:
Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1