#include <dimensions.h>

Public Member Functions
constexpr	Dimensions (size_t x, size_t y=1, size_t z=1, size_t n=1, size_t pad_x=0, size_t pad_y=0, size_t pad_z=0)

constexpr Dimensions	createSingle () const

constexpr Dimensions	copyForN (size_t n) const

CUDA_HD constexpr size_t	x () const

constexpr size_t	xPadded () const

CUDA_HD constexpr size_t	y () const

constexpr size_t	yPadded () const

CUDA_HD constexpr size_t	z () const

constexpr size_t	zPadded () const

CUDA_HD constexpr size_t	n () const

constexpr size_t	xy () const

constexpr size_t	xyPadded () const

CUDA_HD constexpr size_t	xyz () const

constexpr size_t	xyzPadded () const

CUDA_HD constexpr size_t	sizeSingle () const

constexpr size_t	size () const

constexpr size_t	sizePadded () const

constexpr bool	equalSizesIgnorePadding (const Dimensions &b) const

constexpr bool	equalExceptNPadded (const Dimensions &b) const

constexpr bool	equalPadding (const Dimensions &b) const

constexpr bool	isValid () const

constexpr bool	operator== (const Dimensions &b) const

constexpr bool	operator!= (const Dimensions &b) const

constexpr bool	isPadded () const

constexpr bool	is1D () const

CUDA_HD constexpr bool	is2D () const

CUDA_HD constexpr bool	is3D () const

CUDA_HD int	getDimAsNumber () const

Friends
std::ostream &	operator<< (std::ostream &os, const Dimensions &d)

Detailed Description

Definition at line 35 of file dimensions.h.

Constructor & Destructor Documentation

◆ Dimensions()

constexpr Dimensions::Dimensions	(	size_t	x,
		size_t	y = `1`,
		size_t	z = `1`,
		size_t	n = `1`,
		size_t	pad_x = `0`,
		size_t	pad_y = `0`,
		size_t	pad_z = `0`
	)

inlineexplicit

Definition at line 37 of file dimensions.h.

                                                                   :
             m_x(x), m_y(y), m_z(z), m_n(n),
             m_pad_x(pad_x), m_pad_y(pad_y), m_pad_z(pad_z) {}

Member Function Documentation

◆ copyForN()

constexpr Dimensions Dimensions::copyForN ( size_t n ) const

inline

Definition at line 46 of file dimensions.h.

                                                   {
         return Dimensions(m_x, m_y, m_z, n, m_pad_x, m_pad_y, m_pad_z);
     }

◆ createSingle()

constexpr Dimensions Dimensions::createSingle ( ) const

inline

Definition at line 42 of file dimensions.h.

                                               {
         return Dimensions(m_x, m_y, m_z, 1, m_pad_x, m_pad_y, m_pad_z);
     }

◆ equalExceptNPadded()

constexpr bool Dimensions::equalExceptNPadded ( const Dimensions & b ) const

inline

Definition at line 124 of file dimensions.h.

                                                                         {
         return (m_x == b.m_x)
                 && (m_y == b.m_y)
                 && (m_z == b.m_z)
                 // && (m_n == b.m_n) ignore on purpose
                 && equalPadding(b);
     }

◆ equalPadding()

constexpr bool Dimensions::equalPadding ( const Dimensions & b ) const

inline

Definition at line 132 of file dimensions.h.

                                                                   {
         return (m_pad_x == b.m_pad_x)
                 && (m_pad_y == b.m_pad_y)
                 && (m_pad_z == b.m_pad_z);
     }

◆ equalSizesIgnorePadding()

constexpr bool Dimensions::equalSizesIgnorePadding ( const Dimensions & b ) const

inline

Definition at line 117 of file dimensions.h.

                                                                              {
         return (m_x == b.m_x)
                 && (m_y == b.m_y)
                 && (m_z == b.m_z)
                 && (m_n == b.m_n);
     }

◆ getDimAsNumber()

CUDA_HD int Dimensions::getDimAsNumber ( ) const

inline

Definition at line 172 of file dimensions.h.

                                       {
         if (is3D()) return 3;
         if (is2D()) return 2;
         return 1;
     }

◆ is1D()

constexpr bool Dimensions::is1D ( ) const

inline

Definition at line 157 of file dimensions.h.

                                 {
         return (m_z == 1) && (m_y == 1);
     }

◆ is2D()

CUDA_HD constexpr bool Dimensions::is2D ( ) const

inline

Definition at line 162 of file dimensions.h.

                                 {
         return (m_z == 1) && (m_y != 1);
     }

◆ is3D()

CUDA_HD constexpr bool Dimensions::is3D ( ) const

inline

Definition at line 167 of file dimensions.h.

                                 {
         return (m_z != 1) && (m_y != 1);
     }

◆ isPadded()

constexpr bool Dimensions::isPadded ( ) const

inline

Definition at line 153 of file dimensions.h.

                                            {
         return (0 != m_pad_x) || (0 != m_pad_y) || (0 != m_pad_z);
     }

◆ isValid()

constexpr bool Dimensions::isValid ( ) const

inline

Definition at line 138 of file dimensions.h.

                                           {
         return (0 != m_x)
                 && (0 != m_y)
                 && (0 != m_z)
                 && (0 != m_n);
     }

◆ n()

CUDA_HD constexpr size_t Dimensions::n ( ) const

inline

Definition at line 78 of file dimensions.h.

                                {
         return m_n;
     }

◆ operator!=()

constexpr bool Dimensions::operator!= ( const Dimensions & b ) const

inline

Definition at line 149 of file dimensions.h.

                                                          {
         return !(*this == b);
     }

◆ operator==()

constexpr bool Dimensions::operator== ( const Dimensions & b ) const

inline

Definition at line 145 of file dimensions.h.

                                                          {
         return equalSizesIgnorePadding(b) && equalPadding(b);
     }

◆ size()

constexpr size_t Dimensions::size ( ) const

inline

Definition at line 104 of file dimensions.h.

                                          {
         return xyz() * m_n;
     }

◆ sizePadded()

constexpr size_t Dimensions::sizePadded ( ) const

inline

Definition at line 108 of file dimensions.h.

                                                {
         return xyzPadded() * m_n;
     }

◆ sizeSingle()

CUDA_HD constexpr size_t Dimensions::sizeSingle ( ) const

inline

Definition at line 100 of file dimensions.h.

                                         {
         return xyz();
     }

◆ x()

CUDA_HD constexpr size_t Dimensions::x ( ) const

inline

Definition at line 51 of file dimensions.h.

                                {
         return m_x;
     }

◆ xPadded()

constexpr size_t Dimensions::xPadded ( ) const

inline

Definition at line 55 of file dimensions.h.

                                             {
         return m_x + m_pad_x;
     }

◆ xy()

constexpr size_t Dimensions::xy ( ) const

inline

Definition at line 82 of file dimensions.h.

                                        {
         return m_x * m_y;
     }

◆ xyPadded()

constexpr size_t Dimensions::xyPadded ( ) const

inline

Definition at line 86 of file dimensions.h.

                                              {
         return (m_x + m_pad_x) * (m_y + m_pad_y);
     }

◆ xyz()

CUDA_HD constexpr size_t Dimensions::xyz ( ) const

inline

Definition at line 91 of file dimensions.h.

                                  {
         return m_x * m_y * m_z;
     }

◆ xyzPadded()

constexpr size_t Dimensions::xyzPadded ( ) const

inline

Definition at line 95 of file dimensions.h.

                                               {
         return (m_x + m_pad_x) * (m_y + m_pad_y) * (m_z + m_pad_z);
     }

◆ y()

CUDA_HD constexpr size_t Dimensions::y ( ) const

inline

Definition at line 60 of file dimensions.h.

                                {
         return m_y;
     }

◆ yPadded()

constexpr size_t Dimensions::yPadded ( ) const

inline

Definition at line 64 of file dimensions.h.

                                             {
         return m_y + m_pad_y;
     }

◆ z()

CUDA_HD constexpr size_t Dimensions::z ( ) const

inline

Definition at line 69 of file dimensions.h.

                                {
         return m_z;
     }

◆ zPadded()

constexpr size_t Dimensions::zPadded ( ) const

inline

Definition at line 73 of file dimensions.h.

                                             {
         return m_z + m_pad_z;
     }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const Dimensions &	d
	)

friend

Definition at line 112 of file dimensions.h.

                                                                        {
         os << d.x() << " * " << d.y() << " * " << d.z() << " * " << d.n();
         return os;
     }

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

xmipp/libraries/data/dimensions.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Dimensions()

Member Function Documentation

◆ copyForN()

◆ createSingle()

◆ equalExceptNPadded()

◆ equalPadding()

◆ equalSizesIgnorePadding()

◆ getDimAsNumber()

◆ is1D()

◆ is2D()

◆ is3D()

◆ isPadded()

◆ isValid()

◆ n()

◆ operator!=()

◆ operator==()

◆ size()

◆ sizePadded()

◆ sizeSingle()

◆ x()

◆ xPadded()

◆ xy()

◆ xyPadded()

◆ xyz()

◆ xyzPadded()

◆ y()

◆ yPadded()

◆ z()

◆ zPadded()

Friends And Related Function Documentation

◆ operator<<