ZLimits.h File Reference

Defines class ZLimits. More...

Include dependency graph for ZLimits.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	OneSidedLimit
	Helper class that represents a onesided limit. More...
struct	ParticleLimits
	Vertical extension of a particle, specified by bottom and top z coordinate. More...
class	ZLimits
	Class that contains upper and lower limits of the z-coordinate for the slicing of form factors. More...

Macros
#define	BORNAGAIN_SAMPLE_SCATTERING_ZLIMITS_H

Functions
ZLimits	ConvexHull (const ZLimits &left, const ZLimits &right)
OneSidedLimit	MaxLimit (const OneSidedLimit &left, const OneSidedLimit &right)
OneSidedLimit	MinLimit (const OneSidedLimit &left, const OneSidedLimit &right)
bool	operator!= (const OneSidedLimit &left, const OneSidedLimit &right)
bool	operator!= (const ZLimits &left, const ZLimits &right)
std::ostream &	operator<< (std::ostream &ostr, const OneSidedLimit &limit)
std::ostream &	operator<< (std::ostream &ostr, const ZLimits &limits)
bool	operator== (const OneSidedLimit &left, const OneSidedLimit &right)
bool	operator== (const ZLimits &left, const ZLimits &right)

Detailed Description

Defines class ZLimits.

Homepage:\n http://www.bornagainproject.org

License:\n GNU General Public License v3 or higher (see COPYING)

Copyright

Forschungszentrum Jülich GmbH 2018

Authors

Scientific Computing Group at MLZ (see CITATION, AUTHORS)

Definition in file ZLimits.h.

Macro Definition Documentation

BORNAGAIN_SAMPLE_SCATTERING_ZLIMITS_H

#define BORNAGAIN_SAMPLE_SCATTERING_ZLIMITS_H

Definition at line 21 of file ZLimits.h.

Function Documentation

ConvexHull()

ZLimits ConvexHull	(	const ZLimits &	left,
		const ZLimits &	right
	)

Definition at line 82 of file ZLimits.cpp.

{
    return {MinLimit(left.lowerLimit(), right.lowerLimit()),
            MaxLimit(left.upperLimit(), right.upperLimit())};
}

References ZLimits::lowerLimit(), MaxLimit(), MinLimit(), and ZLimits::upperLimit().

Here is the call graph for this function:

MaxLimit()

OneSidedLimit MaxLimit	(	const OneSidedLimit &	left,
		const OneSidedLimit &	right
	)

Definition at line 56 of file ZLimits.cpp.

{
    if (left.m_limitless || right.m_limitless)
        return {true, 0};
    return {false, std::max(left.m_value, right.m_value)};
}

References OneSidedLimit::m_limitless, and OneSidedLimit::m_value.

Referenced by ConvexHull().

MinLimit()

OneSidedLimit MinLimit	(	const OneSidedLimit &	left,
		const OneSidedLimit &	right
	)

Definition at line 49 of file ZLimits.cpp.

{
    if (left.m_limitless || right.m_limitless)
        return {true, 0};
    return {false, std::min(left.m_value, right.m_value)};
}

References OneSidedLimit::m_limitless, and OneSidedLimit::m_value.

Referenced by ConvexHull().

operator!=() [1/2]

bool operator!=	(	const OneSidedLimit &	left,
		const OneSidedLimit &	right
	)

Definition at line 72 of file ZLimits.cpp.

{
    return !(left == right);
}

operator!=() [2/2]

bool operator!=	(	const ZLimits &	left,
		const ZLimits &	right
	)

Definition at line 93 of file ZLimits.cpp.

{
    return !(left == right);
}

operator<<() [1/2]

std::ostream& operator<<	(	std::ostream &	ostr,
		const OneSidedLimit &	limit
	)

Definition at line 77 of file ZLimits.cpp.

{
    return ostr << "{" << (limit.m_limitless ? "true, " : "false, ") << limit.m_value << "}";
}

References OneSidedLimit::m_limitless, and OneSidedLimit::m_value.

operator<<() [2/2]

std::ostream& operator<<	(	std::ostream &	ostr,
		const ZLimits &	limits
	)

Definition at line 98 of file ZLimits.cpp.

{
    return ostr << "Lower: " << limits.lowerLimit() << ", Upper: " << limits.upperLimit();
}

References ZLimits::lowerLimit(), and ZLimits::upperLimit().

Here is the call graph for this function:

operator==() [1/2]

bool operator==	(	const OneSidedLimit &	left,
		const OneSidedLimit &	right
	)

Definition at line 63 of file ZLimits.cpp.

{
    if (left.m_limitless != right.m_limitless)
        return false;
    if (!left.m_limitless && left.m_value != right.m_value)
        return false;
    return true;
}

References OneSidedLimit::m_limitless, and OneSidedLimit::m_value.

operator==() [2/2]

bool operator==	(	const ZLimits &	left,
		const ZLimits &	right
	)

Definition at line 88 of file ZLimits.cpp.

{
    return (left.lowerLimit() == right.lowerLimit() && left.upperLimit() == right.upperLimit());
}

References ZLimits::lowerLimit(), and ZLimits::upperLimit().

Here is the call graph for this function: