Classification

The results of a call to CommonGenerators.classify.

The classify function takes a PartialFunction and a Generator, and organizes the values created by the Generator based on the PartialFunction. It returns this data structure, which describes how many of the values went into each bucket.

If the PartialFunction did not cover all the possible generated values, then the totals field will not include the others, and the numbers in totals will add up to less than totalGenerated.

totalGenerated: How many values were actually created by the Generator overall.
totals: For each of the buckets defined in the PartialFunction, how many values belonged in each one.

Source: Classification.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Classification(totalGenerated: PosInt, totals: Map[String, PosZInt])

totalGenerated
How many values were actually created by the Generator overall.
totals
For each of the buckets defined in the PartialFunction, how many values belonged in each one.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def percentages: Map[String, PosZInt]

For each bucket, what percentage of the generated values fell into it?
For each bucket, what percentage of the generated values fell into it?
This is essentially a lower-precision but easier-to-understand variant of portions.
returns
Approximately what proportion of the values fell into each bucket.
def portions: Map[String, Double]

For each bucket, what fraction of the generated values fell into it?
For each bucket, what fraction of the generated values fell into it?
returns
Exactly what proportion of the values fell into each bucket.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Classification → AnyRef → Any
val totalGenerated: PosInt

How many values were actually created by the Generator overall.
val totals: Map[String, PosZInt]

For each of the buckets defined in the PartialFunction, how many values belonged in each one.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package prop

case class Classification(totalGenerated: PosInt, totals: Map[String, PosZInt]) extends Product with Serializable

Instance Constructors

new Classification(totalGenerated: PosInt, totals: Map[String, PosZInt])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def percentages: Map[String, PosZInt]

def portions: Map[String, Double]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

val totalGenerated: PosInt

val totals: Map[String, PosZInt]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped