MADNESS libraries

Collaboration diagram for MADNESS libraries:

Modules
	Containers
	Parallel programming environment
	Chemistry

Files
file	constants.h
	Defines common mathematical and physical constants.
file	madness_config.h
	Macros and tools pertaining to the configuration of MADNESS.
file	madness_exception.cc
	Implementation of madness::MadnessException.
file	madness_exception.h
	Defines madness::MadnessException for exception handling.
file	mem_func_wrapper.h
	Defines tools for encapsulating a pointer to a member function.
file	print.cc
	Implementation of functions defined in print.h.
file	print.h
	Defines simple templates for printing to std::cout "a la Python".
file	print_seq.h
	Implements print_seq.

Functions
template<typename T >
std::ostream &	madness::operators::operator<< (std::ostream &s, const std::complex< T > &c)
	Easy printing of complex numbers.
template<typename T >
std::ostream &	madness::operators::operator<< (std::ostream &s, const std::list< T > &c)
	Easy printing of lists.
template<typename T , typename U >
std::ostream &	madness::operators::operator<< (std::ostream &s, const std::pair< T, U > &p)
	Easy printing of pairs.
template<typename T >
std::ostream &	madness::operators::operator<< (std::ostream &s, const std::vector< T > &c)
	Easy printing of vectors.
template<typename T , std::size_t N>
std::enable_if<!std::is_same< T, char >::value, std::ostream & >::type	madness::operators::operator<< (std::ostream &s, const T(&v)[N])
	Easy printing of fixed dimension arrays.

Detailed Description

MADNESS is built from several libraries, such as the parallel runtime and the multiresolution analysis tools. The files and submodules listed here detail the API and implementation of these libraries.

Todo:

Add additional details to this section, if needed.

The MADNESS framework provides several container classes for convenience. They are described herein.

Function Documentation

operator<<() [1/5]

template<typename T >

std::ostream & madness::operators::operator<<	(	std::ostream &	s,
		const std::complex< T > &	c
	)

Easy printing of complex numbers.

Template Parameters

T	The "real" type of the complex number.

Parameters

[in,out]	s	The output stream.
[in]	c	The complex number.

Returns

The output stream (for chaining).

References c.

operator<<() [2/5]

template<typename T >

std::ostream & madness::operators::operator<<	(	std::ostream &	s,
		const std::list< T > &	c
	)

Easy printing of lists.

Template Parameters

T	Type stored in the list.

Parameters

[in,out]	s	The output stream.
[in]	c	The list.

Returns

The output stream (for chaining).

References c.

operator<<() [3/5]

template<typename T , typename U >

std::ostream & madness::operators::operator<<	(	std::ostream &	s,
		const std::pair< T, U > &	p
	)

Easy printing of pairs.

Template Parameters

T	Type 1 of the pair.
U	Type 2 of the pair.

Parameters

[in,out]	s	The output stream.
[in]	p	The pair.

Returns

The output stream (for chaining).

References p().

operator<<() [4/5]

template<typename T >

std::ostream & madness::operators::operator<<	(	std::ostream &	s,
		const std::vector< T > &	c
	)

Easy printing of vectors.

Template Parameters

T	Type stored in the vector.

Parameters

[in,out]	s	The output stream.
[in]	c	The vector.

Returns

The output stream (for chaining).

References c.

operator<<() [5/5]

template<typename T , std::size_t N>

std::enable_if<!std::is_same< T, char >::value, std::ostream & >::type madness::operators::operator<<	(	std::ostream &	s,
		const T(&)	v[N]
	)

Easy printing of fixed dimension arrays.

STL I/O already does char (thus the enable_if business).

Template Parameters

T	Type of data in the array.
N	Size of the array.

Parameters

[in,out]	s	The output stream.
[in]	v	The array.

Returns

The output stream (for chaining).

References N, and v.