Ginkgo  Generated from pipelines/224724463 branch based on develop. Ginkgo version 1.3.0
A numerical linear algebra library targeting many-core architectures
Public Member Functions | Static Public Member Functions | List of all members
gko::log::Stream< ValueType > Class Template Reference

Stream is a Logger which logs every event to a stream. More...

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

Collaboration diagram for gko::log::Stream< ValueType >:
[legend]

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 *, 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 *solutino, 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...
 
- Public Member Functions inherited from gko::log::Logger
template<size_type Event, typename... Params>
std::enable_if_t< Event==0 &&(0< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==1 &&(1< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==2 &&(2< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==3 &&(3< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==4 &&(4< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==5 &&(5< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==6 &&(6< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==7 &&(7< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==8 &&(8< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==9 &&(9< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==10 &&(10< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==11 &&(11< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==12 &&(12< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==13 &&(13< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==14 &&(14< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==15 &&(15< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==16 &&(16< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==17 &&(17< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==18 &&(18< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==19 &&(19< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==20 &&(20< event_count_max)> on (Params &&... params) const
 
template<size_type Event, typename... Params>
std::enable_if_t< Event==21 &&(21< event_count_max)> on (Params &&... params) const
 

Static Public Member Functions

static std::unique_ptr< Streamcreate (std::shared_ptr< const Executor > exec, const Logger::mask_type &enabled_events=Logger::all_events_mask, std::ostream &os=std::cout, bool verbose=false)
 Creates a Stream 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

template<typename ValueType = default_precision>
class gko::log::Stream< ValueType >

Stream is a Logger which logs every event to a stream.

This can typically be used to log to a file or to the console.

Template Parameters
ValueTypethe type of values stored in the class (i.e. ValueType template parameter of the concrete Loggable this class will log)

Member Function Documentation

◆ create()

template<typename ValueType = default_precision>
static std::unique_ptr<Stream> gko::log::Stream< ValueType >::create ( std::shared_ptr< const Executor exec,
const Logger::mask_type &  enabled_events = Logger::all_events_mask,
std::ostream &  os = std::cout,
bool  verbose = false 
)
inlinestatic

Creates a Stream logger.

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

Parameters
execthe executor
enabled_eventsthe events enabled for this logger. By default all events.
osthe stream used for this logger
verbosewhether we want detailed information or not. This includes always printing residuals and other information which can give a large output.
Returns
an std::unique_ptr to the the constructed object

◆ on_allocation_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_allocation_completed ( const Executor exec,
const size_type num_bytes,
const uintptr &  location 
) const
overridevirtual

Executor's allocation completed event.

Parameters
execthe executor used
num_bytesthe number of bytes allocated
locationthe address at which the data was allocated

Reimplemented from gko::log::Logger.

◆ on_allocation_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_allocation_started ( const Executor exec,
const size_type num_bytes 
) const
overridevirtual

Executor's allocation started event.

Parameters
execthe executor used
num_bytesthe number of bytes to allocate

Reimplemented from gko::log::Logger.

◆ on_copy_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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_fromthe executor copied from
exec_tothe executor copied to
loc_fromthe address at which the data was copied from
loc_tothe address at which the data was copied to
num_bytesthe number of bytes copied

Reimplemented from gko::log::Logger.

◆ on_copy_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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_fromthe executor to be copied from
exec_tothe executor to be copied to
loc_fromthe address at which the data will be copied from
loc_tothe address at which the data will be copied to
num_bytesthe number of bytes to be copied

Reimplemented from gko::log::Logger.

◆ on_criterion_check_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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
criterionthe criterion used
itthe current iteration count
rthe residual
tauthe residual norm
xthe solution
stopping_idthe id of the stopping criterion
set_finalizedwhether this finalizes the iteration
statusthe stopping status of the right hand sides
one_changedwhether at least one right hand side converged or not
all_convergedwhether all right hand sides

Reimplemented from gko::log::Logger.

◆ on_criterion_check_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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
criterionthe criterion used
itthe current iteration count
rthe residual
tauthe residual norm
xthe solution
stopping_idthe id of the stopping criterion
set_finalizedwhether this finalizes the iteration

Reimplemented from gko::log::Logger.

◆ on_free_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_free_completed ( const Executor exec,
const uintptr &  location 
) const
overridevirtual

Executor's free completed event.

Parameters
execthe executor used
locationthe address at which the data was freed

Reimplemented from gko::log::Logger.

◆ on_free_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_free_started ( const Executor exec,
const uintptr &  location 
) const
overridevirtual

Executor's free started event.

Parameters
execthe executor used
locationthe address at which the data will be freed

Reimplemented from gko::log::Logger.

◆ on_iteration_complete()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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
itthe current iteration count
rthe residual
xthe solution vector (optional)
tauthe residual norm (optional)

Reimplemented from gko::log::Logger.

◆ on_linop_advanced_apply_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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
Athe system matrix
alphascaling of the result of op(b)
bthe input vector(s)
betascaling of the input x
xthe output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_advanced_apply_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::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
Athe system matrix
alphascaling of the result of op(b)
bthe input vector(s)
betascaling of the input x
xthe output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_apply_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_linop_apply_completed ( const LinOp A,
const LinOp b,
const LinOp x 
) const
overridevirtual

LinOp's apply completed event.

Parameters
Athe system matrix
bthe input vector(s)
xthe output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_apply_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_linop_apply_started ( const LinOp A,
const LinOp b,
const LinOp x 
) const
overridevirtual

LinOp's apply started event.

Parameters
Athe system matrix
bthe input vector(s)
xthe output vector(s)

Reimplemented from gko::log::Logger.

◆ on_linop_factory_generate_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_linop_factory_generate_completed ( const LinOpFactory factory,
const LinOp input,
const LinOp output 
) const
overridevirtual

LinOp Factory's generate completed event.

Parameters
factorythe factory used
inputthe LinOp object used as input for the generation (usually a system matrix)
outputthe generated LinOp object

Reimplemented from gko::log::Logger.

◆ on_linop_factory_generate_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_linop_factory_generate_started ( const LinOpFactory factory,
const LinOp input 
) const
overridevirtual

LinOp Factory's generate started event.

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

Reimplemented from gko::log::Logger.

◆ on_operation_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_operation_completed ( const Executor exec,
const Operation op 
) const
overridevirtual

Executor's operation completed event (method run).

Parameters
execthe executor used
opthe 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()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_operation_launched ( const Executor exec,
const Operation op 
) const
overridevirtual

Executor's operation launched event (method run).

Parameters
execthe executor used
opthe operation launched

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_copy_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_polymorphic_object_copy_completed ( const Executor exec,
const PolymorphicObject input,
const PolymorphicObject output 
) const
overridevirtual

PolymorphicObject's copy completed event.

Parameters
execthe executor used
inputthe PolymorphicObject to be copied from
outputthe PolymorphicObject to be copied to

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_copy_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_polymorphic_object_copy_started ( const Executor exec,
const PolymorphicObject input,
const PolymorphicObject output 
) const
overridevirtual

PolymorphicObject's copy started event.

Parameters
execthe executor used
inputthe PolymorphicObject to be copied from
outputthe PolymorphicObject to be copied to

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_create_completed()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_polymorphic_object_create_completed ( const Executor exec,
const PolymorphicObject input,
const PolymorphicObject output 
) const
overridevirtual

PolymorphicObject's create completed event.

Parameters
execthe executor used
inputthe PolymorphicObject used as model for the creation
outputthe PolymorphicObject which was created

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_create_started()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_polymorphic_object_create_started ( const Executor exec,
const PolymorphicObject po 
) const
overridevirtual

PolymorphicObject's create started event.

Parameters
execthe executor used
pothe PolymorphicObject to be created

Reimplemented from gko::log::Logger.

◆ on_polymorphic_object_deleted()

template<typename ValueType = default_precision>
void gko::log::Stream< ValueType >::on_polymorphic_object_deleted ( const Executor exec,
const PolymorphicObject po 
) const
overridevirtual

PolymorphicObject's deleted event.

Parameters
execthe executor used
pothe PolymorphicObject to be deleted

Reimplemented from gko::log::Logger.


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