ARTS 2.5.10 (git: 2f1c442c)
matpack Namespace Reference

Namespaces

namespace  eigen
 
namespace  external_class
 For external class interoperability.
 

Classes

struct  is_complex
 A concept overload to remove non std::complex<> from list. More...
 
struct  is_complex< std::complex< T > >
 A concept whose ::value member is true if this is a complex type. More...
 

Concepts

concept  matpack_type
 
concept  has_nelem
 
concept  has_ncols
 
concept  has_nrows
 
concept  has_npages
 
concept  has_nbooks
 
concept  has_nshelves
 
concept  has_nvitrines
 
concept  has_nlibraries
 
concept  column_keeper
 Checks if the type has any accepted types of columns.
 
concept  row_keeper
 Checks if the type has any accepted types of rows as well as previous sizes.
 
concept  page_keeper
 Checks if the type has any accepted types of pages as well as previous sizes.
 
concept  book_keeper
 Checks if the type has any accepted types of books as well as previous sizes.
 
concept  shelf_keeper
 Checks if the type has any accepted types of shelves as well as previous sizes.
 
concept  vitrine_keeper
 Checks if the type has any accepted types of vitrines as well as previous sizes.
 
concept  library_keeper
 Checks if the type has any accepted types of libraries as well as previous sizes.
 
concept  complex_or_real
 A concept to state if the type is a floating point or a floating point complex.
 
concept  vector_like
 A concept for an Arts vector-like type with access operations.
 
concept  vector
 A concept for any of the Arts vector types.
 
concept  vector_like_not_vector
 A concept precluding Arts vector objects but allowing things similar to vectors.
 
concept  matrix_like
 A concept for an Arts matrix-like type with access operations.
 
concept  matrix
 A concept for any of the Arts matrix types.
 
concept  matrix_like_not_matrix
 A concept precluding Arts matrix objects but allowing things similar to matrices.
 
concept  matrix_or_vector
 Matrix or vector.
 
concept  tensor3_like
 A concept for an Arts matrix-like type with access operations.
 
concept  tensor3_like_not_tensor3
 A concept precluding Arts types but allowing the tensor-like object.
 
concept  tensor4_like
 A concept for an Arts matrix-like type with access operations.
 
concept  tensor4_like_not_tensor4
 A concept precluding Arts types but allowing the tensor-like object.
 
concept  tensor5_like
 A concept for an Arts matrix-like type with access operations.
 
concept  tensor5_like_not_tensor5
 A concept precluding Arts types but allowing the tensor-like object.
 
concept  tensor6_like
 A concept for an Arts matrix-like type with access operations.
 
concept  tensor6_like_not_tensor6
 A concept precluding Arts types but allowing the tensor-like object.
 
concept  tensor7_like
 A concept for an Arts matrix-like type with access operations.
 
concept  tensor7_like_not_tensor7
 A concept precluding Arts types but allowing the tensor-like object.
 
concept  matpack_like
 

Functions

constexpr auto column_size (column_keeper auto &&x)
 Get a column size from x.
 
constexpr auto row_size (row_keeper auto &&x)
 Get a row size from x.
 
constexpr auto page_size (page_keeper auto &&x)
 Get a page size from x.
 
constexpr auto book_size (book_keeper auto &&x)
 Get a book size from x.
 
constexpr auto shelf_size (shelf_keeper auto &&x)
 Get a shelf size from x.
 
constexpr auto vitrine_size (vitrine_keeper auto &&x)
 Get a vitrine size from x.
 
constexpr auto library_size (library_keeper auto &&x)
 Get a library size from x.
 
template<matpack_like T>
constexpr std::size_t dim ()
 
template<class IndexType , std::size_t N>
constexpr std::array< IndexType, Nshape (matpack_like auto &&x)
 Creates a shape array (note that this might create compile time errors if N is larger than x allows for)
 

Function Documentation

◆ book_size()

constexpr auto matpack::book_size ( book_keeper auto &&  x)
constexpr

Get a book size from x.

Definition at line 108 of file matpack_concepts.h.

Referenced by shape().

◆ column_size()

constexpr auto matpack::column_size ( column_keeper auto &&  x)
constexpr

Get a column size from x.

Definition at line 77 of file matpack_concepts.h.

Referenced by shape().

◆ dim()

template<matpack_like T>
constexpr std::size_t matpack::dim ( )
constexpr

Definition at line 258 of file matpack_concepts.h.

◆ library_size()

constexpr auto matpack::library_size ( library_keeper auto &&  x)
constexpr

Get a library size from x.

Definition at line 135 of file matpack_concepts.h.

Referenced by shape().

◆ page_size()

constexpr auto matpack::page_size ( page_keeper auto &&  x)
constexpr

Get a page size from x.

Definition at line 99 of file matpack_concepts.h.

Referenced by shape().

◆ row_size()

constexpr auto matpack::row_size ( row_keeper auto &&  x)
constexpr

Get a row size from x.

Definition at line 89 of file matpack_concepts.h.

Referenced by shape().

◆ shape()

template<class IndexType , std::size_t N>
constexpr std::array< IndexType, N > matpack::shape ( matpack_like auto &&  x)
constexpr

Creates a shape array (note that this might create compile time errors if N is larger than x allows for)

Definition at line 265 of file matpack_concepts.h.

References ARTS_USER_ERROR_IF, book_size(), column_size(), library_size(), N, page_size(), row_size(), shelf_size(), and vitrine_size().

◆ shelf_size()

constexpr auto matpack::shelf_size ( shelf_keeper auto &&  x)
constexpr

Get a shelf size from x.

Definition at line 117 of file matpack_concepts.h.

Referenced by shape().

◆ vitrine_size()

constexpr auto matpack::vitrine_size ( vitrine_keeper auto &&  x)
constexpr

Get a vitrine size from x.

Definition at line 126 of file matpack_concepts.h.

Referenced by shape().