Ratios between libraries and the one color scale every table of the site shares. A ratio is always "how many times worse than the baseline": 1 is the baseline itself, 2 is twice as slow or twice as large, and under 1 is better, which only happens against a chosen reference library.
12 declarations
(ratio: number, floor: number): boolean import {ratio_is_within_floor} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; Whether a ratio is inside a noise floor: the two numbers differ by no more than the machine shows between two measurements of the same library.
rationumberfloora deviation as BenchNoiseFloor holds it; 0.03 is 3%
numberboolean readonly string[] import {RATIO_LEVEL_COLORS} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The color of each level, as fuz_css variables that adapt to the color scheme: better than the reference, level with the baseline, then five steps worse, through yellow, orange, red, and brown to purple.
readonly number[] import {RATIO_LEVEL_LIMITS} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The ratios under which each level of the scale ends. A ratio at or past the last one is the last level. The scale reaches 100, since the libraries measured here are up to hundreds of times apart: a scale that stopped at a few times would color most of a table alike.
RatioDirection type "lower" | "higher"
import type {RatioDirection} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; Whether a smaller or a larger number is the better one.
RatioLegendEntry import type {RatioLegendEntry} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; One level of the color scale as a key shows it: its color and the ratios it covers.
colortype string
labeltype string
noteWhat the level means, beyond its ratios, or null.
type string | null
(ratio: number): string import {to_bound_color} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The color of a ratio that is only a lower bound. A bound is taken against a row's resolution, not against the best in the row, so it is never given the color of a number level with the baseline, however close to 1 it is: a number that is at least the resolution is worse than one inside it.
rationumberstring (values: readonly number[]): number | null import {to_geomean} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The geometric mean of positive numbers, or null for none.
valuesreadonly number[]number | null
(value: number, baseline: number, direction: RatioDirection): number | null import {to_ratio} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; How many times worse value is than baseline.
valuenumberbaselinenumberdirectionnumber | null
the ratio, or null when either number isn't positive and finite, so a ratio is never made from a zero
(ratio: number): string import {to_ratio_color} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The color of a ratio. The tables tint a cell with it and always print the ratio too.
rationumberstring (ratio: number, bound: boolean): string import {to_ratio_display_color} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The color of a ratio as shown: a lower bound's when bound, the scale's
otherwise. Every table cell, table bar, and chart ratio is colored through it.
rationumberboundbooleanstring (): RatioLegendEntry[] import {to_ratio_legend} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The color scale as a key, level by level, from the limits it is drawn from, so the key can't disagree with the cells.
(ratio: number): number import {to_ratio_level} from '@ryanatkn/syntax-highlighter-bench/ratio.js'; The level of the color scale a ratio falls in, from 0 (better than the reference) to the last index of RATIO_LEVEL_COLORS. It never decreases as the ratio grows.
rationumbernumber