config.h File Reference

Go to the source code of this file.

Namespaces
namespace	FrictionQPotSpringBlock
	Tensor products / operations.
namespace	FrictionQPotSpringBlock::array_type
	Container type.

Macros
#define	FRICTIONQPOTSPRINGBLOCK_REQUIRE(expr)    FRICTIONQPOTSPRINGBLOCK_ASSERT_IMPL(expr, __FILE__, __LINE__)
	Assertions that cannot be disabled.
#define	FRICTIONQPOTSPRINGBLOCK_ASSERT(expr)
	All assertions are implementation as:
#define	FRICTIONQPOTSPRINGBLOCK_DEBUG(expr)
	Some costly assertions, that are there mostly for debugging, are implemented as:
#define	FRICTIONQPOTSPRINGBLOCK_WARNING(message)    FRICTIONQPOTSPRINGBLOCK_WARNING_IMPL(message, __FILE__, __LINE__)
	All warnings are implemented as::
#define	FRICTIONQPOTSPRINGBLOCK_WARNING_PYTHON(message)
	All warnings specific to the Python API are implemented as:
#define	FRICTIONQPOTSPRINGBLOCK_VERSION   "@PROJECT_VERSION@"
	Current version.

Typedefs
template<typename T , size_t N>
using	FrictionQPotSpringBlock::array_type::tensor = xt::xtensor<T, N>
	Fixed (static) rank array.
template<typename T >
using	FrictionQPotSpringBlock::array_type::array = xt::xarray<T>
	Arbitrary rank array.
using	FrictionQPotSpringBlock::size_type = ptrdiff_t
	Type using for size and shapes of arrays.

Functions
std::string	FrictionQPotSpringBlock::detail::unquote (const std::string &arg)
	Remove quotes from a string.
std::string	FrictionQPotSpringBlock::version ()
	Return version string, e.g.

Detailed Description

Copyright

Copyright 2020. Tom de Geus. All rights reserved.

License: This project is released under the GNU Public License (MIT).

Definition in file config.h.

Macro Definition Documentation

FRICTIONQPOTSPRINGBLOCK_ASSERT

#define FRICTIONQPOTSPRINGBLOCK_ASSERT

(

expr

)

All assertions are implementation as:

FRICTIONQPOTSPRINGBLOCK_ASSERT(...)

They can be enabled by:

#define FRICTIONQPOTSPRINGBLOCK_ENABLE_ASSERT

(before including FrictionQPotSpringBlock). The advantage is that:

• File and line-number are displayed if the assertion fails.
• FrictionQPotSpringBlock's assertions can be enabled/disabled independently from those of other libraries.

Exceptions

std::runtime_error

Definition at line 62 of file config.h.

FRICTIONQPOTSPRINGBLOCK_DEBUG

#define FRICTIONQPOTSPRINGBLOCK_DEBUG

(

expr

)

Some costly assertions, that are there mostly for debugging, are implemented as:

FRICTIONQPOTSPRINGBLOCK_DEBUG(...)

They can be enabled by:

#define FRICTIONQPOTSPRINGBLOCK_ENABLE_DEBUG

(before including FrictionQPotSpringBlock). See also FRICTIONQPOTSPRINGBLOCK_ASSERT.

Exceptions

std::runtime_error

Definition at line 83 of file config.h.

FRICTIONQPOTSPRINGBLOCK_REQUIRE

#define FRICTIONQPOTSPRINGBLOCK_REQUIRE

(

expr

)

FRICTIONQPOTSPRINGBLOCK_ASSERT_IMPL(expr, __FILE__, __LINE__)

Assertions that cannot be disabled.

Exceptions

std::runtime_error

Definition at line 37 of file config.h.

FRICTIONQPOTSPRINGBLOCK_VERSION

#define FRICTIONQPOTSPRINGBLOCK_VERSION   "@PROJECT_VERSION@"

Current version.

Either:

• Configure using CMake at install time. Internally uses::

  python -c "from setuptools_scm import get_version; print(get_version())"
  

• Define externally using::

  -DFRICTIONQPOTSPRINGBLOCK_VERSION="`python -c "from setuptools_scm import get_version;
  

  print(get_version())"`"

  From the root of this project. This is what ``setup.py`` does.
  

  Note that both CMakeLists.txt and setup.py will construct the version using setuptools_scm. Tip: use the environment variable SETUPTOOLS_SCM_PRETEND_VERSION to overwrite the automatic version.

Definition at line 139 of file config.h.

FRICTIONQPOTSPRINGBLOCK_WARNING

#define FRICTIONQPOTSPRINGBLOCK_WARNING

(

message

)

FRICTIONQPOTSPRINGBLOCK_WARNING_IMPL(message, __FILE__, __LINE__)

All warnings are implemented as::

FRICTIONQPOTSPRINGBLOCK_WARNING(...)

They can be disabled by::

#define FRICTIONQPOTSPRINGBLOCK_DISABLE_WARNING

Definition at line 98 of file config.h.

FRICTIONQPOTSPRINGBLOCK_WARNING_PYTHON

#define FRICTIONQPOTSPRINGBLOCK_WARNING_PYTHON

(

message

)

All warnings specific to the Python API are implemented as:

FRICTIONQPOTSPRINGBLOCK_WARNING_PYTHON(...)

They can be enabled by:

#define FRICTIONQPOTSPRINGBLOCK_ENABLE_WARNING_PYTHON

Definition at line 115 of file config.h.

Function Documentation

unquote()

std::string FrictionQPotSpringBlock::detail::unquote ( const std::string & arg )

inline

Remove quotes from a string.

Parameters

arg

String.

Returns

String.

Definition at line 196 of file config.h.