underling.hpp File Reference

Detailed Description

Provides C++ wrappers for the C-based API in underling.h. In particular, provides RAII semantics for underling's opaque types and some std::basic_ostream helpers.

Go to the source code of this file.

Classes
class	underling::noncopyable
	A mixin for making a subclass non-copyable via private inheritance. More...
class	underling::grid
	Provides a thin RAII wrapper for underling_grid. More...
class	underling::problem
	Provides a thin RAII wrapper for underling_problem. More...
class	underling::plan
	Provides a thin RAII wrapper for underling_plan. More...

Namespaces
	underling
	Provides C++ wrappers for underling's C-based API.
	underling::transpose
	Wraps transpose direction flags.
	underling::transposed
	Wraps transposed storage flags.

Typedefs
typedef underling_real	underling::real
typedef underling_extents	underling::extents

Enumerations
enum	{   underling::transpose::long_n2_to_long_n1, underling::transpose::long_n1_to_long_n0, underling::transpose::long_n0_to_long_n1, underling::transpose::long_n1_to_long_n2,   underling::transpose::all, underling::transpose::none }
enum	{ underling::transposed::long_n2, underling::transposed::long_n0 }

Functions
size_t	underling::local_memory_maximum (const grid &g, const problem &p)
size_t	underling::local_memory_minimum (const grid &g, const problem &p)
size_t	underling::global_memory (const grid &g, const problem &p)
size_t	underling::global_memory_optimum (const grid &g, const problem &p)
template<typename charT , typename traits >
std::basic_ostream< charT, traits > &	operator<< (std::basic_ostream< charT, traits > &os, const underling::extents &e)
	Outputs an underling_extents or underling::extents instance as a human-readable string on any std::basic_ostream. More...
bool	operator== (const underling::extents &e1, const underling::extents &e2)

Function Documentation

operator<<()

template<typename charT , typename traits >

std::basic_ostream<charT,traits>& operator<<	(	std::basic_ostream< charT, traits > &	os,
		const underling::extents &	e
	)

Outputs an underling_extents or underling::extents instance as a human-readable string on any std::basic_ostream.

Parameters

os	On which to output e.
e	To be output.

Returns

The modified os.

operator==()

bool operator== ( const underling::extents &  e1, const underling::extents &  e2  )

inline

See also

underling_extents_cmp