Package com.google.caliper.model

These classes model the data that is collected by the caliper runner: the record of which scenarios were tested on which VMs by which instruments and, most importantly, all the measurements that were observed.

See:
          Description

Class Summary
CaliperData Note: classes in this package are deliberately quick-and-dirty and minimal, and may be upgraded to be a little more robust in the future.
Environment The collected information that caliper detects about the hardware and operating system it is running under.
Instrument The details of what kind of measurement was taken and how; three examples of instruments are "the memory-allocation instrument with default settings", "the microbenchmark instrument with default settings," and "the microbenchmark instrument with warmup time 2 seconds and timing interval 0.5 seconds".
Measurement A single numeric datum reported by an instrument for a particular scenario.
Result A set of measurements, optionally including arbitrary report text, that were taken by a particular instrument for a particular scenario.
Run Represents a single invocation of the caliper runner.
Scenario A specific combination of benchmark variables (including environment, VM, class name, method name, user parameters and VM arguments).
VM A virtual machine configuration.
 

Annotation Types Summary
AllocationMeasurement Annotation that identifies a given method as an "allocation measurement" method.
ArbitraryMeasurement Annotation that identifies a given method as an "arbitrary measurement" method.
 

Package com.google.caliper.model Description

These classes model the data that is collected by the caliper runner: the record of which scenarios were tested on which VMs by which instruments and, most importantly, all the measurements that were observed. The goal of these classes is to be as easily convertible back and forth to JSON text as possible.

We've kept them very quick-and-dirty for now (public mutable fields!?!), but may buff them up after things stabilize.



Copyright © 2009-2011 Google, Inc.. All Rights Reserved.