# Statistics Class
Provides tracking performance statistics to the engine
# Methods
# end
▸ end(name
: StatType): void
Defined in src/statistics/Statistics.ts:59 (opens new window)
Stops tracking particular statistic. Raise error if tracking statistic wasn't started.
Parameters:
Name | Type | Description |
---|---|---|
name | StatType | statistic to stop tracking |
Returns: void
# incrementCriterionFunctionFullCacheUsed
▸ incrementCriterionFunctionFullCacheUsed(): void
Defined in src/statistics/Statistics.ts:18 (opens new window)
Returns: void
# incrementCriterionFunctionPartialCacheUsed
▸ incrementCriterionFunctionPartialCacheUsed(): void
Defined in src/statistics/Statistics.ts:24 (opens new window)
Returns: void
# measure
▸ measure‹T›(name
: StatType, func
: function): T
Defined in src/statistics/Statistics.ts:80 (opens new window)
Measure given statistic as execution of given function.
Type parameters:
▪ T
Parameters:
▪ name: StatType
statistic to track
▪ func: function
function to call
▸ (): T
Returns: T
result of the function call
# reset
▸ reset(): void
Defined in src/statistics/Statistics.ts:33 (opens new window)
Resets statistics
Returns: void
# snapshot
▸ snapshot(): Map‹StatType, number›
Defined in src/statistics/Statistics.ts:90 (opens new window)
Returns the snapshot of current results
Returns: Map‹StatType, number›
# start
▸ start(name
: StatType): void
Defined in src/statistics/Statistics.ts:45 (opens new window)
Starts tracking particular statistic.
Parameters:
Name | Type | Description |
---|---|---|
name | StatType | statistic to start tracking |
Returns: void