interface MTypeMetric

nitc :: MTypeMetric

A metric about MType

Introduced properties

Redefined properties

redef type ELM: MType

nitc $ MTypeMetric :: ELM

Type of elements measured by this metric.
redef type SELF: MTypeMetric

nitc $ MTypeMetric :: SELF

Type of this instance, automatically specialized in every class

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
abstract fun above_threshold: Set[ELM]

nitc :: Metric :: above_threshold

The set of element above the threshold
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
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
package_diagram nitc::MTypeMetric MTypeMetric nitc::Metric Metric nitc::MTypeMetric->nitc::Metric serialization::Serializable Serializable nitc::Metric->serialization::Serializable ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable nitc::TNLI TNLI nitc::TNLI->nitc::MTypeMetric nitc::TNLC TNLC nitc::TNLC->nitc::MTypeMetric nitc::TAGS TAGS nitc::TAGS->nitc::MTypeMetric nitc::TDGS TDGS nitc::TDGS->nitc::MTypeMetric

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

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

Parents

interface Metric

nitc :: Metric

A Metric is used to collect data about things

Children

class TAGS

nitc :: TAGS

Type Metric: Arity of Generic Signature
class TDGS

nitc :: TDGS

Type Metric: Depth of Generic Signature
class TNLC

nitc :: TNLC

Type Metric: Number of Live Cast
class TNLI

nitc :: TNLI

Type Metric: Number of Live Instances

Class definitions

nitc $ MTypeMetric 
# A metric about MType
interface MTypeMetric
	super Metric
	redef type ELM: MType
end
src/metrics/rta_metrics.nit:284,1--288,3
Nit tools. Version .