regina::python Namespace Reference

Utility classes and routines to assist with Python bindings for the calculation engine. More...

Classes
class	ConstArray
	A template class that references a constant one-dimensional "array-like" object. More...
class	GlobalArray
	A template class that references a constant one-dimensional C++ array. More...
class	GlobalArray2D
	A template class that references a constant two-dimensional C++ array. More...
class	GlobalArray3D
	A template class that references a constant three-dimensional C++ array. More...

Functions
template<typename Array >
std::ostream &	operator<< (std::ostream &out, const ConstArray< Array > &arr)
	Writes a string representation of the given array, including all of its elements, to the given output stream. More...
template<typename T , pybind11::return_value_policy rvp>
std::ostream &	operator<< (std::ostream &out, const GlobalArray< T, rvp > &arr)
	Writes a string representation of the given array, including all of its elements, to the given output stream. More...
template<typename T , pybind11::return_value_policy rvp>
std::ostream &	operator<< (std::ostream &out, const GlobalArray2D< T, rvp > &arr)
	Writes a string representation of the given array, including all of its elements, to the given output stream. More...
template<typename T , pybind11::return_value_policy rvp>
std::ostream &	operator<< (std::ostream &out, const GlobalArray3D< T, rvp > &arr)
	Writes a string representation of the given array, including all of its elements, to the given output stream. More...

Detailed Description

Utility classes and routines to assist with Python bindings for the calculation engine.

Function Documentation

operator<<() [1/4]

template<typename Array >

std::ostream & regina::python::operator<<	(	std::ostream &	out,
		const ConstArray< Array > &	arr
	)

Writes a string representation of the given array, including all of its elements, to the given output stream.

Parameters

out	the output stream to which to write.
arr	the array whose contents are to be written.

Returns

the given output stream.

operator<<() [2/4]

template<typename T , pybind11::return_value_policy rvp>

std::ostream & regina::python::operator<<	(	std::ostream &	out,
		const GlobalArray2D< T, rvp > &	arr
	)

Writes a string representation of the given array, including all of its elements, to the given output stream.

Parameters

out	the output stream to which to write.
arr	the array whose contents are to be written.

Returns

the given output stream.

operator<<() [3/4]

template<typename T , pybind11::return_value_policy rvp>

std::ostream & regina::python::operator<<	(	std::ostream &	out,
		const GlobalArray3D< T, rvp > &	arr
	)

Writes a string representation of the given array, including all of its elements, to the given output stream.

Parameters

out	the output stream to which to write.
arr	the array whose contents are to be written.

Returns

the given output stream.

operator<<() [4/4]

template<typename T , pybind11::return_value_policy rvp>

std::ostream & regina::python::operator<<	(	std::ostream &	out,
		const GlobalArray< T, rvp > &	arr
	)

Writes a string representation of the given array, including all of its elements, to the given output stream.

Parameters

out	the output stream to which to write.
arr	the array whose contents are to be written.

Returns

the given output stream.