ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
Utils::Array< T, N > Struct Template Reference

#include <Array.hpp>

+ Inheritance diagram for Utils::Array< T, N >:

Public Types

using value_type = T
 
using size_type = std::size_t
 
using difference_type = std::ptrdiff_t
 
using reference = value_type &
 
using const_reference = const value_type &
 
using iterator = value_type *
 
using const_iterator = const value_type *
 
using pointer = value_type *
 
using const_pointer = const value_type *
 

Public Member Functions

DEVICE_QUALIFIER constexpr reference at (size_type i)
 
DEVICE_QUALIFIER constexpr const_reference at (size_type i) const
 
DEVICE_QUALIFIER constexpr reference operator[] (size_type i)
 
DEVICE_QUALIFIER constexpr const_reference operator[] (size_type i) const
 
DEVICE_QUALIFIER constexpr reference front ()
 
DEVICE_QUALIFIER constexpr const_reference front () const
 
DEVICE_QUALIFIER constexpr reference back ()
 
DEVICE_QUALIFIER constexpr const_reference back () const
 
DEVICE_QUALIFIER constexpr pointer data () noexcept
 
DEVICE_QUALIFIER constexpr const_pointer data () const noexcept
 
DEVICE_QUALIFIER constexpr iterator begin () noexcept
 
DEVICE_QUALIFIER constexpr const_iterator begin () const noexcept
 
DEVICE_QUALIFIER constexpr const_iterator cbegin () const noexcept
 
DEVICE_QUALIFIER constexpr iterator end () noexcept
 
DEVICE_QUALIFIER constexpr const_iterator end () const noexcept
 
DEVICE_QUALIFIER constexpr const_iterator cend () const noexcept
 
DEVICE_QUALIFIER constexpr bool empty () const noexcept
 
DEVICE_QUALIFIER constexpr size_type size () const noexcept
 
DEVICE_QUALIFIER constexpr size_type max_size () const noexcept
 
DEVICE_QUALIFIER void fill (const value_type &value)
 

Static Public Member Functions

static DEVICE_QUALIFIER constexpr Array< T, N > broadcast (const value_type &value)
 
static constexpr detail::ArrayFormatter formatter (char const *sep=" ")
 

Public Attributes

detail::Storage< T, N > m_storage
 

Friends

std::ostream & operator<< (std::ostream &out, Array const &a)
 
std::ostream & operator<< (detail::ArrayFormatterStream const &fmt, Array const &a)
 

Detailed Description

template<typename T, std::size_t N>
struct Utils::Array< T, N >

Definition at line 73 of file Array.hpp.

Member Typedef Documentation

◆ const_iterator

template<typename T , std::size_t N>
using Utils::Array< T, N >::const_iterator = const value_type *

Definition at line 80 of file Array.hpp.

◆ const_pointer

template<typename T , std::size_t N>
using Utils::Array< T, N >::const_pointer = const value_type *

Definition at line 82 of file Array.hpp.

◆ const_reference

template<typename T , std::size_t N>
using Utils::Array< T, N >::const_reference = const value_type &

Definition at line 78 of file Array.hpp.

◆ difference_type

template<typename T , std::size_t N>
using Utils::Array< T, N >::difference_type = std::ptrdiff_t

Definition at line 76 of file Array.hpp.

◆ iterator

template<typename T , std::size_t N>
using Utils::Array< T, N >::iterator = value_type *

Definition at line 79 of file Array.hpp.

◆ pointer

template<typename T , std::size_t N>
using Utils::Array< T, N >::pointer = value_type *

Definition at line 81 of file Array.hpp.

◆ reference

template<typename T , std::size_t N>
using Utils::Array< T, N >::reference = value_type &

Definition at line 77 of file Array.hpp.

◆ size_type

template<typename T , std::size_t N>
using Utils::Array< T, N >::size_type = std::size_t

Definition at line 75 of file Array.hpp.

◆ value_type

template<typename T , std::size_t N>
using Utils::Array< T, N >::value_type = T

Definition at line 74 of file Array.hpp.

Member Function Documentation

◆ at() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr reference Utils::Array< T, N >::at ( size_type  i)
inlineconstexpr

Definition at line 86 of file Array.hpp.

References DEVICE_THROW, and Utils::Array< T, N >::m_storage.

Referenced by calc_rg().

◆ at() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_reference Utils::Array< T, N >::at ( size_type  i) const
inlineconstexpr

Definition at line 93 of file Array.hpp.

References DEVICE_THROW, and Utils::Array< T, N >::m_storage.

◆ back() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr reference Utils::Array< T, N >::back ( )
inlineconstexpr

Definition at line 114 of file Array.hpp.

References Utils::Array< T, N >::end().

◆ back() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_reference Utils::Array< T, N >::back ( ) const
inlineconstexpr

Definition at line 116 of file Array.hpp.

References Utils::Array< T, N >::cend().

◆ begin() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_iterator Utils::Array< T, N >::begin ( ) const
inlineconstexprnoexcept

Definition at line 132 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

◆ begin() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr iterator Utils::Array< T, N >::begin ( )
inlineconstexprnoexcept

Definition at line 128 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

Referenced by Utils::Vector< T, N >::as_span(), Utils::Vector< T, N >::as_vector(), Utils::Matrix< T, Rows, Cols >::begin(), Utils::Matrix< T, Rows, Cols >::begin(), Shapes::Ellipsoid::calculate_dist(), DipolarDirectSum::dipole_field_at_part(), Utils::Array< T, N >::front(), Utils::hadamard_division(), Utils::hadamard_division(), Utils::hadamard_product(), p3m_interpolation_cache::load(), Utils::Vector< T, N >::operator Vector< U, N >(), Utils::operator/(), Utils::operator/(), p3m_gpu_init(), walberla::LBWalberlaImpl< FloatType, Architecture >::set_slice_velocity(), walberla::LBWalberlaImpl< FloatType, Architecture >::set_slice_velocity_at_boundary(), Utils::sqrt(), Utils::Vector< T, N >::swap(), and Utils::Vector< T, N >::Vector().

◆ broadcast()

template<typename T , std::size_t N>
static DEVICE_QUALIFIER constexpr Array< T, N > Utils::Array< T, N >::broadcast ( const value_type &  value)
inlinestaticconstexpr

Definition at line 165 of file Array.hpp.

◆ cbegin()

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_iterator Utils::Array< T, N >::cbegin ( ) const
inlineconstexprnoexcept

Definition at line 136 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

Referenced by Utils::Array< T, N >::front(), Utils::hadamard_division(), Utils::hadamard_product(), and Utils::product().

◆ cend()

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_iterator Utils::Array< T, N >::cend ( ) const
inlineconstexprnoexcept

Definition at line 148 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

Referenced by Utils::Array< T, N >::back(), Utils::hadamard_division(), Utils::hadamard_product(), and Utils::product().

◆ data() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_pointer Utils::Array< T, N >::data ( ) const
inlineconstexprnoexcept

Definition at line 124 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

◆ data() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr pointer Utils::Array< T, N >::data ( )
inlineconstexprnoexcept

Definition at line 120 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

Referenced by CoulombTuningAlgorithm< FloatType, Architecture >::calculate_accuracy(), Utils::Mpi::cart_coords(), Utils::Mpi::cart_create(), Utils::Mpi::cart_rank(), Utils::Matrix< T, Rows, Cols >::data(), Utils::Matrix< T, Rows, Cols >::data(), p3m_send_mesh< FloatType >::gather_grid(), fft::fft_data_struct< FloatType >::initialize_fft(), Utils::raster(), and p3m_send_mesh< FloatType >::spread_grid().

◆ empty()

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr bool Utils::Array< T, N >::empty ( ) const
inlineconstexprnoexcept

Definition at line 152 of file Array.hpp.

References Utils::Array< T, N >::size().

◆ end() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_iterator Utils::Array< T, N >::end ( ) const
inlineconstexprnoexcept

Definition at line 144 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

◆ end() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr iterator Utils::Array< T, N >::end ( )
inlineconstexprnoexcept

Definition at line 140 of file Array.hpp.

References Utils::Array< T, N >::m_storage.

Referenced by Utils::Vector< T, N >::as_vector(), Utils::Array< T, N >::back(), Shapes::Ellipsoid::calculate_dist(), Utils::Matrix< T, Rows, Cols >::end(), Utils::Matrix< T, Rows, Cols >::end(), Utils::Vector< T, N >::operator Vector< U, N >(), p3m_gpu_init(), walberla::LBWalberlaImpl< FloatType, Architecture >::set_slice_velocity(), and Utils::Vector< T, N >::swap().

◆ fill()

template<typename T , std::size_t N>
DEVICE_QUALIFIER void Utils::Array< T, N >::fill ( const value_type &  value)
inline

Definition at line 158 of file Array.hpp.

References Utils::Array< T, N >::m_storage, and Utils::Array< T, N >::size().

◆ formatter()

template<typename T , std::size_t N>
static constexpr detail::ArrayFormatter Utils::Array< T, N >::formatter ( char const *  sep = " ")
inlinestaticconstexpr

Definition at line 173 of file Array.hpp.

Referenced by ScriptInterface::LatticeIndices::throw_invalid_index().

◆ front() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr reference Utils::Array< T, N >::front ( )
inlineconstexpr

Definition at line 110 of file Array.hpp.

References Utils::Array< T, N >::begin().

Referenced by Utils::get_cylindrical_sampling_positions().

◆ front() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_reference Utils::Array< T, N >::front ( ) const
inlineconstexpr

Definition at line 112 of file Array.hpp.

References Utils::Array< T, N >::cbegin().

◆ max_size()

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr size_type Utils::Array< T, N >::max_size ( ) const
inlineconstexprnoexcept

Definition at line 156 of file Array.hpp.

◆ operator[]() [1/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr reference Utils::Array< T, N >::operator[] ( size_type  i)
inlineconstexpr

Definition at line 100 of file Array.hpp.

References DEVICE_ASSERT, and Utils::Array< T, N >::m_storage.

◆ operator[]() [2/2]

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr const_reference Utils::Array< T, N >::operator[] ( size_type  i) const
inlineconstexpr

Definition at line 105 of file Array.hpp.

References DEVICE_ASSERT, and Utils::Array< T, N >::m_storage.

◆ size()

template<typename T , std::size_t N>
DEVICE_QUALIFIER constexpr size_type Utils::Array< T, N >::size ( ) const
inlineconstexprnoexcept

Definition at line 154 of file Array.hpp.

Referenced by Utils::Vector< T, N >::as_span(), Utils::Array< T, N >::empty(), Utils::Array< T, N >::fill(), walberla::LBWalberlaImpl< FloatType, Architecture >::set_slice_velocity(), and walberla::LBWalberlaImpl< FloatType, Architecture >::set_slice_velocity_at_boundary().

Friends And Related Symbol Documentation

◆ operator<< [1/2]

template<typename T , std::size_t N>
std::ostream & operator<< ( detail::ArrayFormatterStream const &  fmt,
Array< T, N > const &  a 
)
friend

Definition at line 199 of file Array.hpp.

◆ operator<< [2/2]

template<typename T , std::size_t N>
std::ostream & operator<< ( std::ostream &  out,
Array< T, N > const &  a 
)
friend

Definition at line 195 of file Array.hpp.

Member Data Documentation

◆ m_storage

template<typename T , std::size_t N>
detail::Storage<T, N> Utils::Array< T, N >::m_storage

Definition at line 84 of file Array.hpp.

Referenced by Utils::Array< T, N >::at(), Utils::Array< T, N >::at(), Utils::Array< T, N >::begin(), Utils::Array< T, N >::begin(), Utils::Array< T, N >::cbegin(), Utils::Array< T, N >::cend(), Utils::Array< T, N >::data(), Utils::Array< T, N >::data(), Utils::Array< T, N >::end(), Utils::Array< T, N >::end(), Utils::Array< T, N >::fill(), Utils::Array< T, N >::operator[](), and Utils::Array< T, N >::operator[]().

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