A Metric that collects integer data

Used to count things

Introduced properties

private var _values_cache: Counter[ELM]

nitc :: IntMetric :: _values_cache

IntMetric uses a Counter to store values in intern.

init defaultinit

nitc :: IntMetric :: defaultinit

protected fun values_cache: Counter[ELM]

nitc :: IntMetric :: values_cache

IntMetric uses a Counter to store values in intern.

protected fun values_cache=(values_cache: Counter[ELM])

nitc :: IntMetric :: values_cache=

IntMetric uses a Counter to store values in intern.

Redefined properties

redef type RES: Counter[ELM]

nitc $ IntMetric :: RES

Type of data representation used to associate elements and values.

redef type SELF: IntMetric

nitc $ IntMetric :: SELF

Type of this instance, automatically specialized in every class

redef type VAL: Int

nitc $ IntMetric :: VAL

Type of values used to measure elements.

redef fun above_threshold: Set[ELM]

nitc $ IntMetric :: above_threshold

The set of element above the threshold

redef fun avg: Float

nitc $ IntMetric :: avg

Values average

redef fun clear

nitc $ IntMetric :: clear

Clear all results for this metric

redef fun core_serialize_to(v: Serializer)

nitc :: api_metrics $ IntMetric :: core_serialize_to

Actual serialization of self to serializer

redef fun max: ELM

nitc $ IntMetric :: max

The element with the highest value

redef fun min: ELM

nitc $ IntMetric :: min

The element with the lowest value

redef fun std_dev: Float

nitc $ IntMetric :: std_dev

The values standard derivation

redef fun sum: VAL

nitc $ IntMetric :: sum

The sum of all the values.

redef fun to_console(indent: Int, colors: Bool)

nitc $ IntMetric :: to_console

Pretty print the metric results in console

redef fun values: RES

nitc $ IntMetric :: values

Values for each element

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?

fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?

type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.

type ELM: Object

nitc :: Metric :: ELM

Type of elements measured by this metric.

type RES: Map[ELM, VAL]

nitc :: Metric :: RES

Type of data representation used to associate elements and values.

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class

type VAL: Object

nitc :: Metric :: VAL

Type of values used to measure elements.

fun [](element: ELM): VAL

nitc :: Metric :: []

The value calculated for the element

private var _values_cache: Counter[ELM]

nitc :: IntMetric :: _values_cache

IntMetric uses a Counter to store values in intern.

abstract fun above_threshold: Set[ELM]

nitc :: Metric :: above_threshold

The set of element above the threshold

private fun accept_inspect_serializer(v: InspectSerializer)

serialization :: Serializable :: accept_inspect_serializer

private fun accept_inspect_serializer_core(v: InspectSerializer)

serialization :: Serializable :: accept_inspect_serializer_core

protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON

protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter

protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack

protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according

abstract fun avg: Float

nitc :: Metric :: avg

The values average

protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.

fun class_name: String

core :: Object :: class_name

The class name of the object.

abstract fun clear

nitc :: Metric :: clear

Clear all results for this metric

abstract fun collect(elements: Collection[ELM])

nitc :: Metric :: collect

Collect metric values on elements

fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer

init defaultinit

serialization :: Serializable :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit

nitc :: Metric :: defaultinit

init defaultinit

nitc :: IntMetric :: defaultinit

abstract fun desc: String

nitc :: Metric :: desc

A long and understandable description about what is measured by this metric.

init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer

fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.

fun has_element(element: ELM): Bool

nitc :: Metric :: has_element

Does the element have a value for this metric?

fun hash: Int

core :: Object :: hash

The hash code of the object.

init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.

protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".

intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).

fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?

intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.

abstract fun max: ELM

nitc :: Metric :: max

The element with the highest value

abstract fun min: ELM

nitc :: Metric :: min

The element with the lowest value

protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array

abstract fun name: String

nitc :: Metric :: name

The name of this metric (generally an acronym about the metric).

private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.

intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.

fun output

core :: Object :: output

Display self on stdout (debug only).

intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).

fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization

fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes

fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer

fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON

private fun serialize_to_or_delay(v: Serializer)

serialization :: Serializable :: serialize_to_or_delay

Accept references or force direct serialization (using serialize_to)

fun sort: Array[ELM]

nitc :: Metric :: sort

Sort the metric keys by values

abstract fun std_dev: Float

nitc :: Metric :: std_dev

The values standard derivation

abstract fun sum: VAL

nitc :: Metric :: sum

The sum of all the values.

intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.

fun threshold: Float

nitc :: Metric :: threshold

The value threshold above what elements are considered as 'interesting'

fun to_console(indent: Int, colors: Bool)

nitc :: Metric :: to_console

Pretty print the metric results in console

fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON

abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON

fun to_s: String

core :: Object :: to_s

User readable representation of self.

abstract fun values: RES

nitc :: Metric :: values

Values for each element

protected fun values_cache: Counter[ELM]

nitc :: IntMetric :: values_cache

IntMetric uses a Counter to store values in intern.

protected fun values_cache=(values_cache: Counter[ELM])

nitc :: IntMetric :: values_cache=

IntMetric uses a Counter to store values in intern.

Ancestors

interface Object

The root of the class hierarchy.

interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

interface Metric

A Metric is used to collect data about things

Children

class CDIT

Class Metric: Depth in Inheritance Tree

class CDITC

MClass metric: Class Depth in Inheritance Tree

class CDITI

MClass metric: Interface Depth in Inheritance Tree

class CNBA

Class Metric: Number of MAttributes

class CNBHP

Class Metric: Number of Inherited MProperties

class CNBI

Class Metric: Number of Constructors

class CNBIP

Class Metric: Number of Introduced MProperties

class CNBLP

Class Metric: Number of Local MProperties (Intro + Redef)

class CNBM

Class Metric: Number of MMethods

class CNBNA

Class Metric: Number of nullables MAttributes

class CNBP

Class Metric: Number of MProperties

class CNBRP

Class Metric: Number of Refined MProperties

class CNBV

Class Metric: Number of Virtual Types

class CNLC

Class Metric: Number of Live Cast

class CNLI

Class Metric: Number of Live Instances

class CNOA

Class Metric: Number of Ancestors

class CNOAA

MClass metric: Number of Abstract Class Ancestors

class CNOAC

MClass metric: Number of Class Ancestors

class CNOAI

MClass metric: Number of Interface Ancestors

class CNOC

Class Metric: Number of Children

class CNOCC

MClass metric: Number of Class Children

class CNOCI

MClass metric: Number of Interface Children

class CNOD

Class Metric: Number of Descendants

class CNODC

MClass metric: Number of Class Descendants

class CNODI

MClass metric: Number of Interface Descendants

class CNOP

Class Metric: Number of Parents

class CNOPC

MClass metric: Number of Class Parents

class CNOPI

MClass metric: Number of Interface Parents

class MDIT

Module Metric: Depth in Tree

class MNBAC

Module Metric: Number of Abstract Class in module (intro + redef)

class MNBCC

Module Metric: Number of Concrete Class in module (intro + redef)

class MNBD

Module Metric: Number of Accessible Definitions (of all kind)

class MNBEC

Module Metric: Number of Enum in module (intro + redef)

class MNBI

Module Metric: Number of Introduction (of all kind)

class MNBIC

Module Metric: Number of Interface in module (intro + redef)

class MNBR

Module Metric: Number of Refinement

class MNCT

MModule Metric: Number of Live Cast Types

class MNLC

MModule Metric: Number of Live Classes

class MNLDD

MModule Metric: Number of Dead MethodDefs

class MNLI

MModule Metric: Number of Live Types

class MNLM

MModule Metric: Number of Live Methods

class MNLMD

MModule Metric: Number of Live MethodDefs

class MNLT

MModule Metric: Number of Live Types

class MNOA

Module Metric: Number of Ancestors

class MNOC

Module Metric: Number of Children

class MNOD

Module Metric: Number of Descendants

class MNOP

Module Metric: Number of Parents

class TAGS

Type Metric: Arity of Generic Signature

class TDGS

Type Metric: Depth of Generic Signature

class TNLC

Type Metric: Number of Live Cast

class TNLI

Type Metric: Number of Live Instances

Class definitions

nitc $ IntMetric

# A Metric that collects integer data
#
# Used to count things
class IntMetric
	super Metric

	redef type VAL: Int is fixed
	redef type RES: Counter[ELM]

	# `IntMetric` uses a Counter to store values in intern.
	protected var values_cache = new Counter[ELM]

	redef fun values do return values_cache

	redef fun clear do values_cache.clear

	redef fun sum do return values_cache.sum

	redef fun max do
		assert not values_cache.is_empty
		return values_cache.max.as(not null)
	end

	redef fun min do
		assert not values_cache.is_empty
		return values_cache.min.as(not null)
	end

	# Values average
	redef fun avg do return values_cache.avg

	redef fun std_dev do return values_cache.std_dev

	redef fun above_threshold do
		var above = new HashSet[ELM]
		var threshold = threshold
		for element, value in values do
			if value.to_f > threshold then above.add(element)
		end
		return above
	end

	redef fun to_console(indent, colors) do
		super
		if colors then
			print "{"\t" * indent}  sum: {sum}".light_gray
		else
			print "{"\t" * indent}  sum: {sum}"
		end
	end
end

src/metrics/metrics_base.nit:235,1--285,3

nitc :: api_metrics $ IntMetric

redef class IntMetric
	redef fun core_serialize_to(v) do
		super
		if values.not_empty then v.serialize_attribute("sum", sum)
	end
end

src/doc/api/api_metrics.nit:175,1--180,3