class Lapis::Benchmark::Group

Lapis::Benchmark::Group
Reference
Object

Overview

A Comparison Group bundling multiple targets / benchmarks to compare side by side

Defined in:

libgodot/benchmarks.cr

Constructors

.new(name : String, category : Category = Category::Custom, description : String = "", baseline_name : String | Nil = nil, kind : Symbol = :runtime, chart_types : Array(Symbol) | Nil = nil)

Instance Method Summary

#baseline(name : String) : Void
#baseline_name : String | Nil
#baseline_name=(baseline_name : String | Nil)
#benchmark(name : String, description : String = "", feature : Symbol | Nil = nil, ci_only : Bool = false, subgroup : String | Nil = nil, &block : Int32 -> Nil) : TargetSpec
Register an in-engine Crystal benchmark block inside this group
#category(cat : Category | Symbol | String) : Void
#category : Category
#category=(category : Category)
#chart_type(t : Symbol) : Void
#chart_types : Array(Symbol)
#chart_types=(chart_types : Array(Symbol))
#charts(types : Array(Symbol)) : Void
#charts(*types : Symbol) : Void
#default_chart_types_for(k : Symbol) : Array(Symbol)
#description(desc : String) : Void
#description : String
#description=(description : String)
#kind(k : Symbol) : Void
#kind : Symbol
#kind=(kind : Symbol)
#name : String
#name=(name : String)
#subgroup(name : String, &) : Nil
Declares a logical subgroup within this comparison group
#target(name : String, description : String = "", feature : Symbol | Nil = nil, ci_only : Bool = false, subgroup : String | Nil = nil, &block : Int32 -> Nil) : TargetSpec
Register a target with an in-process block
#target(name : String, file : String, language : Symbol = :crystal, command : String | Nil = nil, release_flags : Array(String) | Nil = nil, description : String = "", feature : Symbol | Nil = nil, ci_only : Bool = false, subgroup : String | Nil = nil, args : Array(String) | Nil = nil) : TargetSpec
Register an external file / multi-language target inside this group
#targets : Array(TargetSpec)
#targets=(targets : Array(TargetSpec))

Constructor Detail

def self.new(name : String, category : Category = Category::Custom, description : String = "", baseline_name : String | Nil = nil, kind : Symbol = :runtime, chart_types : Array(Symbol) | Nil = nil) #

Instance Method Detail

def baseline(name : String) : Void #

def baseline_name : String | Nil #

def baseline_name=(baseline_name : String | Nil) #

def benchmark(name : String, description : String = "", feature : Symbol | Nil = nil, ci_only : Bool = false, subgroup : String | Nil = nil, &block : Int32 -> Nil) : TargetSpec #

Register an in-engine Crystal benchmark block inside this group

def category(cat : Category | Symbol | String) : Void #

def category : Category #

def category=(category : Category) #

def chart_type(t : Symbol) : Void #

def chart_types : Array(Symbol) #

def chart_types=(chart_types : Array(Symbol)) #

def charts(types : Array(Symbol)) : Void #

def charts(*types : Symbol) : Void #

def default_chart_types_for(k : Symbol) : Array(Symbol) #

def description(desc : String) : Void #

def description : String #

def description=(description : String) #

def kind(k : Symbol) : Void #

def kind : Symbol #

def kind=(kind : Symbol) #

def name : String #

def name=(name : String) #

def subgroup(name : String, &) : Nil #

Declares a logical subgroup within this comparison group

def target(name : String, description : String = "", feature : Symbol | Nil = nil, ci_only : Bool = false, subgroup : String | Nil = nil, &block : Int32 -> Nil) : TargetSpec #

Register a target with an in-process block

def target(name : String, file : String, language : Symbol = :crystal, command : String | Nil = nil, release_flags : Array(String) | Nil = nil, description : String = "", feature : Symbol | Nil = nil, ci_only : Bool = false, subgroup : String | Nil = nil, args : Array(String) | Nil = nil) : TargetSpec #

Register an external file / multi-language target inside this group

def targets : Array(TargetSpec) #

def targets=(targets : Array(TargetSpec)) #