DistributedBase Class Reference

DistributedBase Class Reference#

Reference API: gko::experimental::distributed::DistributedBase Class Reference
Reference API
gko::experimental::distributed::DistributedBase Class Reference

#include <ginkgo/core/distributed/base.hpp>

Inheritance diagram for gko::experimental::distributed::DistributedBase:
[legend]

Public Member Functions

 DistributedBase (const DistributedBase &other)=default
 
 DistributedBase (DistributedBase &&other)=default
 
DistributedBaseoperator= (const DistributedBase &)
 
DistributedBaseoperator= (DistributedBase &&) noexcept
 
mpi::communicator get_communicator () const
 

Protected Member Functions

 DistributedBase (mpi::communicator comm)
 

Detailed Description

A base class for distributed objects.

This class stores and gives access to the used mpi::communicator object.

Note
The communicator is not changed on assignment.

Constructor & Destructor Documentation

◆ DistributedBase()

gko::experimental::distributed::DistributedBase::DistributedBase ( mpi::communicator  comm)
inlineexplicitprotected

Creates a new DistributedBase with the specified mpi::communicator.

Parameters
commused mpi::communicator

Member Function Documentation

◆ get_communicator()

mpi::communicator gko::experimental::distributed::DistributedBase::get_communicator ( ) const
inline

Access the used mpi::communicator.

Returns
used mpi::communicator

◆ operator=() [1/2]

DistributedBase & gko::experimental::distributed::DistributedBase::operator= ( const DistributedBase )
inline

Copy assignment that doesn't change the used mpi::communicator.

Returns
unmodified *this

◆ operator=() [2/2]

DistributedBase & gko::experimental::distributed::DistributedBase::operator= ( DistributedBase &&  )
inlinenoexcept

Move assignment that doesn't change the used mpi::communicator.

Returns
unmodified *this

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