Gromacs  2026.0-dev-20251109-f20ba35
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::BasicMatrix3x3< ElementType > Class Template Reference

#include <gromacs/math/include/gromacs/math/matrix.h>

+ Inheritance diagram for gmx::BasicMatrix3x3< ElementType >:
+ Collaboration diagram for gmx::BasicMatrix3x3< ElementType >:

Description

template<class ElementType>
class gmx::BasicMatrix3x3< ElementType >

Three-by-three matrix of ElementType.

Template Parameters
ElementTypetype of element to be stored in matrix

Public Member Functions

 BasicMatrix3x3 ()
 Default constructor.
 
- Public Member Functions inherited from gmx::MultiDimArray< std::array< ElementType, DIM *DIM >, extents< DIM, DIM > >
 MultiDimArray (IndexType...dynamicExtent)
 Allocate dynamic array data and set view with the dynamic extents. More...
 
constexpr MultiDimArray (const std::array< ElementType, DIM *DIM > &data={}) noexcept
 Construction from fixed sized arrays if the array size is static and layout policy allows compile time determination of the container size. More...
 
constexpr MultiDimArray (const MultiDimArray &o)
 Copy constructor.
 
 MultiDimArray (MultiDimArray &&o) noexcept
 Move constructor.
 
MultiDimArrayoperator= (const MultiDimArray &o)
 Copy assignment.
 
MultiDimArrayoperator= (MultiDimArray &&o) noexcept
 Move assignment.
 
void swap (MultiDimArray &o) noexcept
 Swaps content with other.
 
void resize (IndexType...dynamicExtent)
 Resize the dynamic extents of the array if any and set container size accordingly. More...
 
reference operator() (IndexType...index) noexcept
 Data access via multidimensional indices. This allows referencing rank R array elements as array(x_0,x_1,x_2, .., x_R) More...
 
constexpr const_reference operator() (IndexType...index) const noexcept
 Const data access via multidimensional indices. This allows referencing rank R array elements as array(x_0,x_1,x_2, .., x_R) More...
 
ArrayRef< value_typetoArrayRef ()
 Contiguous access to the data. More...
 
constexpr ArrayRef< const
value_type
toArrayRef () const
 Contiguous const access to the data. More...
 
constexpr view_type::index_type extent (int k) const noexcept
 Return the extent. More...
 
constexpr view_type asView () noexcept
 Conversion to multidimensional view on the data.
 
constexpr const_view_type asConstView () const noexcept
 Conversion to const multidimensional view on the data.
 

Additional Inherited Members

- Public Types inherited from gmx::MultiDimArray< std::array< ElementType, DIM *DIM >, extents< DIM, DIM > >
using value_type = typename std::array< ElementType, DIM *DIM >::value_type
 the type of values that are stored
 
using reference = typename std::array< ElementType, DIM *DIM >::reference
 reference type to the stored values
 
using const_reference = typename std::array< ElementType, DIM *DIM >::const_reference
 const reference type to the stored values
 
using view_type = basic_mdspan< value_type, extents< DIM, DIM >, layout_right >
 the view used to access the data
 
using const_view_type = basic_mdspan< const value_type, extents< DIM, DIM >, layout_right >
 const view on the data
 
using iterator = typename ArrayRef< value_type >::iterator
 Iterator type for contiguous iteration over the stored data. Used, e.g., in free begin and end functions.
 
using const_iterator = const typename ArrayRef< const value_type >::const_iterator
 Const iterator type for contiguous iteration over the stored data. used, e.g., in free begin and end functions.
 

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