ZLimits.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Scattering/ZLimits.h
//! @brief     Defines class ZLimits.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_SAMPLE_SCATTERING_ZLIMITS_H
#define BORNAGAIN_SAMPLE_SCATTERING_ZLIMITS_H
 
#include <iostream>
 
//! Vertical extension of a particle, specified by bottom and top z coordinate.
struct ParticleLimits {
    double m_bottom;
    double m_top;
};
 
//! Helper class that represents a onesided limit
//!
//! @ingroup intern
 
struct OneSidedLimit {
    bool m_limitless;
    double m_value;
};
 
//! Class that contains upper and lower limits of the z-coordinate for the slicing of
//! form factors.
//!
//! @ingroup intern
 
class ZLimits {
public:
    ZLimits();
    ZLimits(double min, double max);
    ZLimits(OneSidedLimit lower_limit, OneSidedLimit upper_limit);
 
    bool isFinite() const;
 
    OneSidedLimit lowerLimit() const;
    OneSidedLimit upperLimit() const;
 
private:
    OneSidedLimit m_lower;
    OneSidedLimit m_upper;
};
 
OneSidedLimit MinLimit(const OneSidedLimit& left, const OneSidedLimit& right);
OneSidedLimit MaxLimit(const OneSidedLimit& left, const OneSidedLimit& right);
bool operator==(const OneSidedLimit& left, const OneSidedLimit& right);
bool operator!=(const OneSidedLimit& left, const OneSidedLimit& right);
 
std::ostream& operator<<(std::ostream& ostr, const OneSidedLimit& limit);
 
ZLimits ConvexHull(const ZLimits& left, const ZLimits& right);
bool operator==(const ZLimits& left, const ZLimits& right);
bool operator!=(const ZLimits& left, const ZLimits& right);
 
std::ostream& operator<<(std::ostream& ostr, const ZLimits& limits);
 
#endif // BORNAGAIN_SAMPLE_SCATTERING_ZLIMITS_H
#endif // USER_API