Macros.hpp File Reference

#include "axom/config.hpp"
#include <cassert>

Macros
#define	AXOM_DEVICE
#define	AXOM_HOST_DEVICE
	CUDA host/device macros for decorating functions/lambdas. More...
#define	AXOM_HOST
#define	AXOM_STRINGIFY(x)   AXOM_DO_STRINGIFY(x)
#define	AXOM_DO_STRINGIFY(x)   #x
#define	AXOM_PRAGMA(x)   _Pragma(AXOM_STRINGIFY(x))
#define	AXOM_SUPPRESS_HD_WARN
#define	AXOM_LAMBDA   [=]
	Convenience macro used for lambda capture by value. More...
#define	AXOM_DEVICE_LAMBDA   [=]
#define	AXOM_HOST_LAMBDA   [=]
#define	AXOM_CUDA_TEST(X, Y)   TEST(X, Y)
	Convenience macro used for a gtest that uses cuda. More...
#define	AXOM_NOT_USED(x)
	Macro used to silence compiler warnings in methods with unused arguments. More...
#define	AXOM_STATIC_ASSERT(cond)   static_assert(cond, #cond)
#define	AXOM_STATIC_ASSERT_MSG(cond, MSG)   static_assert(cond, MSG)
	This macro wraps the compile time static_assert functionality so you don't have to provide a message. More...
#define	AXOM_DEBUG_VAR(_x)   static_cast<void>(_x)
	Macro used to silence compiler warnings about variables that are defined but not used. More...
#define	AXOM_DEBUG_PARAM(_x)
	Macro used to silence compiler warnings about parameters that are used in debug code but not in release code. More...
#define	DISABLE_DEFAULT_CTOR(className)   className() = delete
	Macro to disable default constructor for the given class. More...
#define	DISABLE_COPY_AND_ASSIGNMENT(className)
	Macro to disable copy and assignment operations for the given class. More...
#define	DISABLE_MOVE_AND_ASSIGNMENT(className)
	Macro to disable move constructor and move assignment operations for the given class. More...

Macro Definition Documentation

AXOM_DEVICE

#define AXOM_DEVICE

AXOM_HOST_DEVICE

#define AXOM_HOST_DEVICE

CUDA host/device macros for decorating functions/lambdas.

Note

These will expand to the corresponding CUDA decorations when compiled with -DAXOM_USE_CUDA

Referenced by axom::primal::Point< IndexType, NDIMS >::array(), axom::primal::Vector< SpaceCoordType, NDIMS >::array(), axom::primal::Triangle< T, NDIMS >::baryToPhysical(), axom::primal::BoundingBox< double, DIM >::BoundingBox(), axom::primal::Point< IndexType, NDIMS >::data(), axom::primal::Vector< SpaceCoordType, NDIMS >::data(), axom::primal::Point< IndexType, NDIMS >::dimension(), axom::primal::Vector< SpaceCoordType, NDIMS >::dimension(), axom::slic::detail::FalseType::FalseType(), axom::numerics::Matrix< T >::getDiagonalSize(), axom::primal::BoundingBox< double, DIM >::getMin(), axom::numerics::floating_point_limits< float >::lowest(), axom::numerics::floating_point_limits< double >::lowest(), axom::numerics::floating_point_limits< long double >::lowest(), axom::numerics::floating_point_limits< float >::max(), axom::numerics::floating_point_limits< double >::max(), axom::numerics::floating_point_limits< long double >::max(), axom::numerics::floating_point_limits< float >::min(), axom::numerics::floating_point_limits< double >::min(), axom::numerics::floating_point_limits< long double >::min(), axom::primal::Triangle< T, NDIMS >::normal(), axom::primal::NumericArray< IndexType, NDIMS >::NumericArray(), axom::numerics::Matrix< T >::ones(), axom::StackArray< T, N >::operator T*(), axom::primal::operator!=(), axom::primal::Point< IndexType, NDIMS >::operator=(), axom::StackArray< int64, 6 >::operator[](), axom::primal::Triangle< T, NDIMS >::operator[](), axom::primal::Point< IndexType, NDIMS >::operator[](), axom::primal::Vector< SpaceCoordType, NDIMS >::operator[](), axom::primal::Point< IndexType, NDIMS >::Point(), axom::primal::BoundingBox< double, DIM >::range(), axom::primal::NumericArray< IndexType, NDIMS >::size(), axom::primal::Vector< SpaceCoordType, NDIMS >::Vector(), axom::primal::BoundingBox< double, DIM >::~BoundingBox(), axom::primal::Triangle< T, NDIMS >::~Triangle(), and axom::primal::Vector< SpaceCoordType, NDIMS >::~Vector().

AXOM_HOST

#define AXOM_HOST

AXOM_STRINGIFY

#define AXOM_STRINGIFY

(

x

)

AXOM_DO_STRINGIFY(x)

AXOM_DO_STRINGIFY

#define AXOM_DO_STRINGIFY

(

x

)

#x

AXOM_PRAGMA

#define AXOM_PRAGMA

(

x

)

_Pragma(AXOM_STRINGIFY(x))

AXOM_SUPPRESS_HD_WARN

#define AXOM_SUPPRESS_HD_WARN

AXOM_LAMBDA

#define AXOM_LAMBDA   [=]

Convenience macro used for lambda capture by value.

Note

When CUDA is used, the macro always expands to a host/device lambda.

Warning

When compiling with CUDA, host/device lambdas incur a significant penalty on the CPU code. The way NVCC implements host/device lambdas prevents the compiler from proper in-lining them. When CUDA is enabled use the parallel_gpu execution policy or opt to turn off CUDA if the application is making more use of the parallel_cpu and serial execution policies.

Referenced by axom::quest::getMeshTriangle().

AXOM_DEVICE_LAMBDA

#define AXOM_DEVICE_LAMBDA   [=]

AXOM_HOST_LAMBDA

#define AXOM_HOST_LAMBDA   [=]

AXOM_CUDA_TEST

#define AXOM_CUDA_TEST	(		X,
			Y
	)		TEST(X, Y)

Convenience macro used for a gtest that uses cuda.

AXOM_NOT_USED

#define AXOM_NOT_USED

(

x

)

Macro used to silence compiler warnings in methods with unused arguments.

Note

The intent is to use this macro in the function signature. For example:

void my_function(int x, int AXOM_NOT_USED(y))
{
  // my implementation
}

Referenced by axom::slam::Map< slam::Set< CoordType, CoordType >, OctreeLevelType * >::data(), axom::mint::Mesh::getCellCapacity(), axom::mint::Mesh::getFaceCapacity(), axom::quest::getMeshTriangle(), and axom::spin::BVHTree< T, NDIMS >::writeVtkFile().

AXOM_STATIC_ASSERT

#define AXOM_STATIC_ASSERT

(

cond

)

static_assert(cond, #cond)

Referenced by axom::mint::Lagrange< CELLTYPE >::computeDerivatives(), axom::mint::Lagrange< CELLTYPE >::computeShape(), axom::mint::for_all_cells(), axom::mint::for_all_faces(), axom::mint::for_all_nodes(), axom::mint::Lagrange< CELLTYPE >::getCellType(), axom::mint::Lagrange< CELLTYPE >::getCenter(), axom::mint::Lagrange< CELLTYPE >::getCoords(), axom::mint::Lagrange< CELLTYPE >::getDimension(), axom::mint::Lagrange< CELLTYPE >::getMax(), axom::mint::Lagrange< CELLTYPE >::getMaxNewtonIters(), axom::mint::Lagrange< CELLTYPE >::getMin(), axom::mint::Lagrange< CELLTYPE >::getNumDofs(), axom::mint::Lagrange< CELLTYPE >::getType(), and axom::utilities::random_real().

AXOM_STATIC_ASSERT_MSG

#define AXOM_STATIC_ASSERT_MSG	(		cond,
			MSG
	)		static_assert(cond, MSG)

This macro wraps the compile time static_assert functionality so you don't have to provide a message.

Referenced by axom::numerics::eigen_solve(), axom::numerics::jacobi_eigensolve(), axom::numerics::linspace(), axom::numerics::make_orthogonal(), axom::numerics::normalize(), axom::numerics::orthonormalize(), axom::primal::Plane< T, NDIMS >::Plane(), axom::primal::Sphere< T, NDIMS >::Sphere(), axom::utilities::swapEndian(), and axom::mint::UnstructuredMesh< TOPO >::UnstructuredMesh().

AXOM_DEBUG_VAR

#define AXOM_DEBUG_VAR

(

_x

)

static_cast<void>(_x)

Macro used to silence compiler warnings about variables that are defined but not used.

Note

The intent is to use this macro for variables that are only used for debugging purposes (e.g. in debug assertions). For example:

double myVar = ...
AXOM_DEBUG_VAR(myVar);

// code emits the following warning in release builds
// if extra warnings are enabled and this macro is not called
// warning: unused variable 'myVar' [-Wunused-variable]

SLIC_ASSERT(myVar > 0)

Referenced by axom::quest::detail::InOutOctreeValidator< DIM >::checkEachVertexIsIndexed(), axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::CompileTimeOffset(), axom::slam::policies::CompileTimeSize< IntType, INT_VAL >::CompileTimeSize(), axom::quest::InOutOctree< DIM >::generateIndex(), axom::slam::policies::VirtualParentSubset::isValid(), axom::slam::policies::ArrayIndirection< PositionType, ElementType >::isValid(), axom::slam::policies::ConcreteParentSubset< TheParentSetType >::isValid(), axom::slam::policies::STLVectorIndirection< SetPosition, SetElement >::isValid(), axom::primal::OrientedBoundingBox< T, NDIMS >::OrientedBoundingBox(), axom::slam::BitSet::test(), axom::quest::InOutOctree< DIM >::within(), axom::slam::policies::ZeroOffset< SetPosition >::ZeroOffset(), and axom::slam::policies::ZeroSize< IntType >::ZeroSize().

AXOM_DEBUG_PARAM

#define AXOM_DEBUG_PARAM

(

_x

)

Macro used to silence compiler warnings about parameters that are used in debug code but not in release code.

Note

Default values are ok

void my_function(int x, int AXOM_DEBUG_PARAM(y))
{
  // my implementation
  SLIC_ASSERT(y > 0)
}

Referenced by axom::quest::SignedDistance< NDIMS >::computeDistance(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::copy(), axom::slam::DynamicVariableRelation< PosType, ElemType >::data(), axom::slam::Map< slam::Set< CoordType, CoordType >, OctreeLevelType * >::data(), axom::slam::DynamicConstantRelation< PosType, ElemType, CardinalityPolicy >::data(), axom::slam::NullSet< RelationType::SetPosition, RelationType::SetElement >::empty(), axom::slam::NullBivariateSet< SetPosition, SetElement >::getElements(), axom::slam::FieldRegistry< slam::Set< VertexIndex >, VertexIndex >::getScalar(), axom::slam::ProductSet< PosType, ElemType >::isValid(), axom::slam::RelationSet< RelationType >::isValid(), axom::slam::SubMap< SetType, DataType, SuperMapType, StridePolicy >::isValid(), axom::slam::DynamicMap< SetType, DataType >::isValidEntry(), axom::slam::OrderedSet< IndexType, IndexType, SizePolicy >::positions(), axom::slam::DynamicSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy >::remove(), axom::quest::InOutOctree< DIM >::setVertexWeldThreshold(), axom::primal::NumericArray< IndexType, NDIMS >::size(), and axom::quest::InOutOctree< DIM >::within().

DISABLE_DEFAULT_CTOR

#define DISABLE_DEFAULT_CTOR

(

className

)

className() = delete

Macro to disable default constructor for the given class.

Note

This macro should only be used within the private section of a class, as indicated in the example below.

class Foo
{
public:

    // Public methods here

private:
   DISABLE_DEFAULT_CTOR(Foo);
};

Referenced by axom::sidre::View::getNextValidAttrValueIndex(), axom::sidre::Attribute::getTypeID(), axom::sidre::Buffer::isDescribed(), and axom::sidre::Group::isUsingList().

DISABLE_COPY_AND_ASSIGNMENT

#define DISABLE_COPY_AND_ASSIGNMENT

(

className

)

Value:

className(const className&) = delete;        \
  className& operator=(const className&) = delete

Macro to disable copy and assignment operations for the given class.

Note

This macro should only be used within the private section of a class, as indicated in the example below.

class Foo
{
public:
   Foo();
   ~Foo();

    // Other methods here

private:
   DISABLE_COPY_AND_ASSIGNMENT(Foo);
};

Referenced by axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::blockStatus(), axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresenationType >::blockStatus(), axom::spin::OctreeBase< DIM, InOutBlockData >::blockStatus(), axom::spin::BVHTree< T, NDIMS >::empty(), axom::quest::SignedDistance< NDIMS >::getBVHTree(), axom::mint::MeshCoordinates::getCoordinateArray(), axom::mint::UnstructuredMesh< TOPO >::getFaceCellsArray(), axom::spin::BVH< NDIMS, ExecSpace, FloatType >::getTolerance(), axom::mint::ParticleMesh::isInSidre(), axom::sidre::Group::isUsingList(), and axom::quest::InOutOctree< DIM >::setVertexWeldThreshold().

DISABLE_MOVE_AND_ASSIGNMENT

#define DISABLE_MOVE_AND_ASSIGNMENT

(

className

)

Value:

className(const className&&) = delete;       \
  className& operator=(const className&&) = delete

Macro to disable move constructor and move assignment operations for the given class.

Note

This macro should only be used within the private section of a class, as indicated in the example below.

class Foo
{
public:
   Foo();
   ~Foo();

    // Other methods here

private:
   DISABLE_MOVE_AND_ASSIGNMENT(Foo);
};

Referenced by axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::blockStatus(), axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresenationType >::blockStatus(), axom::spin::OctreeBase< DIM, InOutBlockData >::blockStatus(), axom::spin::BVHTree< T, NDIMS >::empty(), axom::mint::MeshCoordinates::getCoordinateArray(), axom::mint::UnstructuredMesh< TOPO >::getFaceCellsArray(), axom::sidre::View::getNextValidAttrValueIndex(), axom::spin::BVH< NDIMS, ExecSpace, FloatType >::getTolerance(), axom::sidre::Attribute::getTypeID(), axom::sidre::Buffer::isDescribed(), axom::mint::ParticleMesh::isInSidre(), axom::sidre::Group::isUsingList(), and axom::quest::InOutOctree< DIM >::setVertexWeldThreshold().