Record is a Logger which logs every event to an object. More...

#include <ginkgo/core/log/record.hpp>

Collaboration diagram for gko::log::Record:

Classes
struct	logged_data
	Struct storing the actually logged data. More...

Public Member Functions
void	on_allocation_started (const Executor *exec, const size_type &num_bytes) const override
	Executor's allocation started event. More...

void	on_allocation_completed (const Executor *exec, const size_type &num_bytes, const uintptr &location) const override
	Executor's allocation completed event. More...

void	on_free_started (const Executor *exec, const uintptr &location) const override
	Executor's free started event. More...

void	on_free_completed (const Executor *exec, const uintptr &location) const override
	Executor's free completed event. More...

void	on_copy_started (const Executor from, const Executor to, const uintptr &location_from, const uintptr &location_to, const size_type &num_bytes) const override
	Executor's copy started event. More...

void	on_copy_completed (const Executor from, const Executor to, const uintptr &location_from, const uintptr &location_to, const size_type &num_bytes) const override
	Executor's copy completed event. More...

void	on_operation_launched (const Executor exec, const Operation operation) const override
	Executor's operation launched event (method run). More...

void	on_operation_completed (const Executor exec, const Operation operation) const override
	Executor's operation completed event (method run). More...

void	on_polymorphic_object_create_started (const Executor exec, const PolymorphicObject po) const override
	PolymorphicObject's create started event. More...

void	on_polymorphic_object_create_completed (const Executor exec, const PolymorphicObject input, const PolymorphicObject *output) const override
	PolymorphicObject's create completed event. More...

void	on_polymorphic_object_copy_started (const Executor exec, const PolymorphicObject from, const PolymorphicObject *to) const override
	PolymorphicObject's copy started event. More...

void	on_polymorphic_object_copy_completed (const Executor exec, const PolymorphicObject from, const PolymorphicObject *to) const override
	PolymorphicObject's copy completed event. More...

void	on_polymorphic_object_deleted (const Executor exec, const PolymorphicObject po) const override
	PolymorphicObject's deleted event. More...

void	on_linop_apply_started (const LinOp A, const LinOp b, const LinOp *x) const override
	LinOp's apply started event. More...

void	on_linop_apply_completed (const LinOp A, const LinOp b, const LinOp *x) const override
	LinOp's apply completed event. More...

void	on_linop_advanced_apply_started (const LinOp A, const LinOp alpha, const LinOp b, const LinOp beta, const LinOp *x) const override
	LinOp's advanced apply started event. More...

void	on_linop_advanced_apply_completed (const LinOp A, const LinOp alpha, const LinOp b, const LinOp beta, const LinOp *x) const override
	LinOp's advanced apply completed event. More...

void	on_linop_factory_generate_started (const LinOpFactory factory, const LinOp input) const override
	LinOp Factory's generate started event. More...

void	on_linop_factory_generate_completed (const LinOpFactory factory, const LinOp input, const LinOp *output) const override
	LinOp Factory's generate completed event. More...

void	on_criterion_check_started (const stop::Criterion criterion, const size_type &num_iterations, const LinOp residual, const LinOp residual_norm, const LinOp solution, const uint8 &stopping_id, const bool &set_finalized) const override
	stop::Criterion's check started event. More...

void	on_criterion_check_completed (const stop::Criterion criterion, const size_type &num_iterations, const LinOp residual, const LinOp residual_norm, const LinOp solution, const uint8 &stopping_id, const bool &set_finalized, const Array< stopping_status > *status, const bool &one_changed, const bool &all_converged) const override
	stop::Criterion's check completed event. More...

void	on_iteration_complete (const LinOp solver, const size_type &num_iterations, const LinOp residual, const LinOp solution=nullptr, const LinOp residual_norm=nullptr) const override
	Register the `iteration_complete` event which logs every completed iterations. More...

const logged_data &	get () const noexcept
	Returns the logged data. More...

logged_data &	get () noexcept

Public Member Functions inherited from gko::log::Logger
template<size_type Event, typename... Params>
xstd::enable_if_t< Event==0 &&(0< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==1 &&(1< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==2 &&(2< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==3 &&(3< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==4 &&(4< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==5 &&(5< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==6 &&(6< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==7 &&(7< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==8 &&(8< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==9 &&(9< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==10 &&(10< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==11 &&(11< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==12 &&(12< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==13 &&(13< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==14 &&(14< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==15 &&(15< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==16 &&(16< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==17 &&(17< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==18 &&(18< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==19 &&(19< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==20 &&(20< event_count_max)>	on (Params &&... params) const

template<size_type Event, typename... Params>
xstd::enable_if_t< Event==21 &&(21< event_count_max)>	on (Params &&... params) const

Static Public Member Functions
static std::unique_ptr< Record >	create (std::shared_ptr< const Executor > exec, const mask_type &enabled_events=Logger::all_events_mask, size_type max_storage=1)
	Creates a Record logger. More...

Additional Inherited Members
Public Types inherited from gko::log::Logger
using	mask_type = gko::uint64

Static Public Attributes inherited from gko::log::Logger
static constexpr size_type	event_count_max = sizeof(mask_type) * byte_size
	Maximum amount of events (bits) with the current implementation.

static constexpr mask_type	all_events_mask = ~mask_type{0}
	Bitset Mask which activates all events.

static constexpr size_type	allocation_started { 0 }

static constexpr mask_type	allocation_started_mask {mask_type{1} << 0 }

static constexpr size_type	allocation_completed { 1 }

static constexpr mask_type	allocation_completed_mask {mask_type{1} << 1 }

static constexpr size_type	free_started { 2 }

static constexpr mask_type	free_started_mask {mask_type{1} << 2 }

static constexpr size_type	free_completed { 3 }

static constexpr mask_type	free_completed_mask {mask_type{1} << 3 }

static constexpr size_type	copy_started { 4 }

static constexpr mask_type	copy_started_mask {mask_type{1} << 4 }

static constexpr size_type	copy_completed { 5 }

static constexpr mask_type	copy_completed_mask {mask_type{1} << 5 }

static constexpr size_type	operation_launched { 6 }

static constexpr mask_type	operation_launched_mask {mask_type{1} << 6 }

static constexpr size_type	operation_completed { 7 }

static constexpr mask_type	operation_completed_mask {mask_type{1} << 7 }

static constexpr size_type	polymorphic_object_create_started { 8 }

static constexpr mask_type	polymorphic_object_create_started_mask {mask_type{1} << 8 }

static constexpr size_type	polymorphic_object_create_completed { 9 }

static constexpr mask_type	polymorphic_object_create_completed_mask {mask_type{1} << 9 }

static constexpr size_type	polymorphic_object_copy_started { 10 }

static constexpr mask_type	polymorphic_object_copy_started_mask {mask_type{1} << 10 }

static constexpr size_type	polymorphic_object_copy_completed { 11 }

static constexpr mask_type	polymorphic_object_copy_completed_mask {mask_type{1} << 11 }

static constexpr size_type	polymorphic_object_deleted { 12 }

static constexpr mask_type	polymorphic_object_deleted_mask {mask_type{1} << 12 }

static constexpr size_type	linop_apply_started { 13 }

static constexpr mask_type	linop_apply_started_mask {mask_type{1} << 13 }

static constexpr size_type	linop_apply_completed { 14 }

static constexpr mask_type	linop_apply_completed_mask {mask_type{1} << 14 }

static constexpr size_type	linop_advanced_apply_started { 15 }

static constexpr mask_type	linop_advanced_apply_started_mask {mask_type{1} << 15 }

static constexpr size_type	linop_advanced_apply_completed { 16 }

static constexpr mask_type	linop_advanced_apply_completed_mask {mask_type{1} << 16 }

static constexpr size_type	linop_factory_generate_started { 17 }

static constexpr mask_type	linop_factory_generate_started_mask {mask_type{1} << 17 }

static constexpr size_type	linop_factory_generate_completed { 18 }

static constexpr mask_type	linop_factory_generate_completed_mask {mask_type{1} << 18 }

static constexpr size_type	criterion_check_started { 19 }

static constexpr mask_type	criterion_check_started_mask {mask_type{1} << 19 }

static constexpr size_type	criterion_check_completed { 20 }

static constexpr mask_type	criterion_check_completed_mask {mask_type{1} << 20 }

static constexpr size_type	iteration_complete { 21 }

static constexpr mask_type	iteration_complete_mask {mask_type{1} << 21 }

static constexpr mask_type	executor_events_mask
	Bitset Mask which activates all executor events. More...

static constexpr mask_type	operation_events_mask
	Bitset Mask which activates all operation events. More...

static constexpr mask_type	polymorphic_object_events_mask
	Bitset Mask which activates all polymorphic object events. More...

static constexpr mask_type	linop_events_mask
	Bitset Mask which activates all linop events. More...

static constexpr mask_type	linop_factory_events_mask
	Bitset Mask which activates all linop factory events. More...

static constexpr mask_type	criterion_events_mask
	Bitset Mask which activates all criterion events. More...

Detailed Description

Record is a Logger which logs every event to an object.

The object can then be accessed at any time by asking the logger to return it.

Note: Please note that this logger can have significant memory and performance overhead. In particular, when logging events such as the check events, all parameters are cloned. If it is sufficient to clone one parameter, consider implementing a specific logger for this. In addition, it is advised to tune the history size in order to control memory overhead.

Member Function Documentation

◆ create()

static std::unique_ptr<Record> gko::log::Record::create	(	std::shared_ptr< const Executor >	exec,
		const mask_type &	enabled_events = `Logger::all_events_mask`,
		size_type	max_storage = `1`
	)

inlinestatic

Creates a Record logger.

This dynamically allocates the memory, constructs the object and returns an std::unique_ptr to this object.

Parameters

exec	the executor
enabled_events	the events enabled for this logger. By default all events.
max_storage	the size of storage (i.e. history) wanted by the user. By default 0 is used, which means unlimited storage. It is advised to control this to reduce memory overhead of this logger.

Returns: an std::unique_ptr to the the constructed object

◆ get() [1/2]

const logged_data& gko::log::Record::get ( ) const

inlinenoexcept

Returns the logged data.

Returns: the logged data

◆ get() [2/2]

logged_data& gko::log::Record::get ( )

inlinenoexcept

References gko::log::Logger::all_events_mask.

◆ on_allocation_completed()

void gko::log::Record::on_allocation_completed	(	const Executor *	exec,
		const size_type &	num_bytes,
		const uintptr &	location
	)		const

overridevirtual

Executor's allocation completed event.

Parameters

exec	the executor used
num_bytes	the number of bytes allocated
location	the address at which the data was allocated

Reimplemented from gko::log::Logger.

◆ on_allocation_started()

void gko::log::Record::on_allocation_started	(	const Executor *	exec,
		const size_type &	num_bytes
	)		const

overridevirtual

Executor's allocation started event.

Parameters

exec	the executor used
num_bytes	the number of bytes to allocate

Reimplemented from gko::log::Logger.

◆ on_copy_completed()

void gko::log::Record::on_copy_completed	(	const Executor *	exec_from,
		const Executor *	exec_to,
		const uintptr &	loc_from,
		const uintptr &	loc_to,
		const size_type &	num_bytes
	)		const

overridevirtual

Executor's copy completed event.

Parameters

exec_from	the executor copied from
exec_to	the executor copied to
loc_from	the address at which the data was copied from
loc_to	the address at which the data was copied to
num_bytes	the number of bytes copied

Reimplemented from gko::log::Logger.

◆ on_copy_started()

void gko::log::Record::on_copy_started	(	const Executor *	exec_from,
		const Executor *	exec_to,
		const uintptr &	loc_from,
		const uintptr &	loc_to,
		const size_type &	num_bytes
	)		const

overridevirtual

Executor's copy started event.

Parameters

exec_from	the executor to be copied from
exec_to	the executor to be copied to
loc_from	the address at which the data will be copied from
loc_to	the address at which the data will be copied to
num_bytes	the number of bytes to be copied

Reimplemented from gko::log::Logger.

◆ on_criterion_check_completed()

void gko::log::Record::on_criterion_check_completed	(	const stop::Criterion *	criterion,
		const size_type &	it,
		const LinOp *	r,
		const LinOp *	tau,
		const LinOp *	x,
		const uint8 &	stopping_id,
		const bool &	set_finalized,
		const Array< stopping_status > *	status,
		const bool &	one_changed,
		const bool &	all_converged
	)		const

overridevirtual

stop::Criterion's check completed event.

Parameters are the Criterion, the stoppingId, the finalized boolean, the stopping status, plus the output one_changed boolean and output all_converged boolean.

Parameters

criterion	the criterion used
it	the current iteration count
r	the residual
tau	the residual norm
x	the solution
stopping_id	the id of the stopping criterion
set_finalized	whether this finalizes the iteration
status	the stopping status of the right hand sides
one_changed	whether at least one right hand side converged or not
all_converged	whether all right hand sides

Reimplemented from gko::log::Logger.

◆ on_criterion_check_started()

void gko::log::Record::on_criterion_check_started	(	const stop::Criterion *	criterion,
		const size_type &	it,
		const LinOp *	r,
		const LinOp *	tau,
		const LinOp *	x,
		const uint8 &	stopping_id,
		const bool &	set_finalized
	)		const

overridevirtual

stop::Criterion's check started event.

Parameters

criterion	the criterion used
it	the current iteration count
r	the residual
tau	the residual norm
x	the solution
stopping_id	the id of the stopping criterion
set_finalized	whether this finalizes the iteration

Reimplemented from gko::log::Logger.

◆ on_free_completed()

void gko::log::Record::on_free_completed	(	const Executor *	exec,
		const uintptr &	location
	)		const

overridevirtual

Executor's free completed event.

Parameters

exec	the executor used
location	the address at which the data was freed

Reimplemented from gko::log::Logger.

◆ on_free_started()

void gko::log::Record::on_free_started	(	const Executor *	exec,
		const uintptr &	location
	)		const

overridevirtual

Executor's free started event.

Parameters

exec	the executor used
location	the address at which the data will be freed

Reimplemented from gko::log::Logger.

◆ on_iteration_complete()

void gko::log::Record::on_iteration_complete	(	const LinOp *	solver,
		const size_type &	it,
		const LinOp *	r,
		const LinOp *	x = `nullptr`,
		const LinOp *	tau = `nullptr`
	)		const

overridevirtual

Register the iteration_complete event which logs every completed iterations.

Parameters

it	the current iteration count
r	the residual
x	the solution vector (optional)
tau	the residual norm (optional)

Reimplemented from gko::log::Logger.

◆ on_linop_advanced_apply_completed()

void gko::log::Record::on_linop_advanced_apply_completed	(	const LinOp *	A,
		const LinOp *	alpha,
		const LinOp *	b,
		const LinOp *	beta,
		const LinOp *	x
	)		const

overridevirtual

LinOp's advanced apply completed event.

Parameters

A	the system matrix
alpha	scaling of the result of op(b)
b	the input vector(s)
beta	scaling of the input x
x	the output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_advanced_apply_started()

void gko::log::Record::on_linop_advanced_apply_started	(	const LinOp *	A,
		const LinOp *	alpha,
		const LinOp *	b,
		const LinOp *	beta,
		const LinOp *	x
	)		const

overridevirtual

LinOp's advanced apply started event.

Parameters

A	the system matrix
alpha	scaling of the result of op(b)
b	the input vector(s)
beta	scaling of the input x
x	the output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_apply_completed()

void gko::log::Record::on_linop_apply_completed	(	const LinOp *	A,
		const LinOp *	b,
		const LinOp *	x
	)		const

overridevirtual

LinOp's apply completed event.

Parameters

A	the system matrix
b	the input vector(s)
x	the output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_apply_started()

void gko::log::Record::on_linop_apply_started	(	const LinOp *	A,
		const LinOp *	b,
		const LinOp *	x
	)		const

overridevirtual

LinOp's apply started event.

Parameters

A	the system matrix
b	the input vector(s)
x	the output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_factory_generate_completed()

void gko::log::Record::on_linop_factory_generate_completed	(	const LinOpFactory *	factory,
		const LinOp *	input,
		const LinOp *	output
	)		const

overridevirtual

LinOp Factory's generate completed event.

Parameters

factory	the factory used
input	the LinOp object used as input for the generation (usually a system matrix)
output	the generated LinOp object

Reimplemented from gko::log::Logger.

◆ on_linop_factory_generate_started()

void gko::log::Record::on_linop_factory_generate_started	(	const LinOpFactory *	factory,
		const LinOp *	input
	)		const

overridevirtual

LinOp Factory's generate started event.

Parameters

factory	the factory used
input	the LinOp object used as input for the generation (usually a system matrix)

Reimplemented from gko::log::Logger.

◆ on_operation_completed()

void gko::log::Record::on_operation_completed	(	const Executor *	exec,
		const Operation *	op
	)		const

overridevirtual

Executor's operation completed event (method run).

Parameters

exec	the executor used
op	the completed operation

Note: For the GPU, to be certain that the operation completed it is required to call synchronize. This burden falls on the logger. Most of the loggers will do lightweight logging, and therefore this operation for the GPU just notes that the Operation has been sent to the GPU.

Reimplemented from gko::log::Logger.

◆ on_operation_launched()

void gko::log::Record::on_operation_launched	(	const Executor *	exec,
		const Operation *	op
	)		const

overridevirtual

Executor's operation launched event (method run).

Parameters

exec	the executor used
op	the operation launched

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_copy_completed()

void gko::log::Record::on_polymorphic_object_copy_completed	(	const Executor *	exec,
		const PolymorphicObject *	input,
		const PolymorphicObject *	output
	)		const

overridevirtual

PolymorphicObject's copy completed event.

Parameters

exec	the executor used
input	the PolymorphicObject to be copied from
output	the PolymorphicObject to be copied to

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_copy_started()

void gko::log::Record::on_polymorphic_object_copy_started	(	const Executor *	exec,
		const PolymorphicObject *	input,
		const PolymorphicObject *	output
	)		const

overridevirtual

PolymorphicObject's copy started event.

Parameters

exec	the executor used
input	the PolymorphicObject to be copied from
output	the PolymorphicObject to be copied to

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_create_completed()

void gko::log::Record::on_polymorphic_object_create_completed	(	const Executor *	exec,
		const PolymorphicObject *	input,
		const PolymorphicObject *	output
	)		const

overridevirtual

PolymorphicObject's create completed event.

Parameters

exec	the executor used
input	the PolymorphicObject used as model for the creation
output	the PolymorphicObject which was created

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_create_started()

void gko::log::Record::on_polymorphic_object_create_started	(	const Executor *	exec,
		const PolymorphicObject *	po
	)		const

overridevirtual

PolymorphicObject's create started event.

Parameters

exec	the executor used
po	the PolymorphicObject to be created

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_deleted()

void gko::log::Record::on_polymorphic_object_deleted	(	const Executor *	exec,
		const PolymorphicObject *	po
	)		const

overridevirtual

PolymorphicObject's deleted event.

Parameters

exec	the executor used
po	the PolymorphicObject to be deleted

Reimplemented from gko::log::Logger.

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

ginkgo/core/log/record.hpp (f0a50f96)

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ get() [1/2]

◆ get() [2/2]

◆ on_allocation_completed()

◆ on_allocation_started()

◆ on_copy_completed()

◆ on_copy_started()

◆ on_criterion_check_completed()

◆ on_criterion_check_started()

◆ on_free_completed()

◆ on_free_started()

◆ on_iteration_complete()

◆ on_linop_advanced_apply_completed()

◆ on_linop_advanced_apply_started()

◆ on_linop_apply_completed()

◆ on_linop_apply_started()

◆ on_linop_factory_generate_completed()

◆ on_linop_factory_generate_started()

◆ on_operation_completed()

◆ on_operation_launched()

◆ on_polymorphic_object_copy_completed()

◆ on_polymorphic_object_copy_started()

◆ on_polymorphic_object_create_completed()

◆ on_polymorphic_object_create_started()

◆ on_polymorphic_object_deleted()