ppforest2::cli::BenchmarkReport::Style Struct Reference

Display style for benchmark report output. More...

#include <BenchmarkReport.hpp>

Public Member Functions
virtual	~Style ()=default

Protected Types
using	Columns = std::vector<ppforest2::io::layout::Column>

Protected Member Functions
virtual std::string	bad (std::string const &s) const =0
virtual std::string	format_baseline_label (std::string const &timestamp) const =0
virtual std::string	format_footer (std::size_t count, double total_ms) const =0
virtual std::string	format_header (Columns const &columns) const =0
virtual std::string	format_row (Columns const &columns, ppforest2::io::layout::Row const &cells) const =0
virtual std::string	format_title (std::string const &name, std::string const &timestamp) const =0
virtual std::string	good (std::string const &s) const =0
virtual std::string	neutral (std::string const &s) const =0

Friends
struct	BenchmarkReport

Detailed Description

Display style for benchmark report output.

Subclasses provide decoration (colors/emoji) and layout (aligned columns vs markdown tables).

Member Typedef Documentation

Columns

using ppforest2::cli::BenchmarkReport::Style::Columns = std::vector<ppforest2::io::layout::Column>

protected

Constructor & Destructor Documentation

~Style()

virtual ppforest2::cli::BenchmarkReport::Style::~Style ( )

virtualdefault

Member Function Documentation

bad()

virtual std::string ppforest2::cli::BenchmarkReport::Style::bad ( std::string const & s ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

format_baseline_label()

virtual std::string ppforest2::cli::BenchmarkReport::Style::format_baseline_label ( std::string const & timestamp ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

format_footer()

virtual std::string ppforest2::cli::BenchmarkReport::Style::format_footer ( std::size_t count, double total_ms ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

format_header()

virtual std::string ppforest2::cli::BenchmarkReport::Style::format_header ( Columns const & columns ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

format_row()

virtual std::string ppforest2::cli::BenchmarkReport::Style::format_row ( Columns const & columns, ppforest2::io::layout::Row const & cells ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

format_title()

virtual std::string ppforest2::cli::BenchmarkReport::Style::format_title ( std::string const & name, std::string const & timestamp ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

good()

virtual std::string ppforest2::cli::BenchmarkReport::Style::good ( std::string const & s ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

neutral()

virtual std::string ppforest2::cli::BenchmarkReport::Style::neutral ( std::string const & s ) const

protectedpure virtual

Implemented in ppforest2::cli::BenchmarkReport::Markdown, and ppforest2::cli::BenchmarkReport::Text.

Friends And Related Symbol Documentation

BenchmarkReport

friend struct BenchmarkReport

friend

---

The documentation for this struct was generated from the following file:

• core/src/cli/BenchmarkReport.hpp