include/EvtGenBase/EvtPoint1D.hh

0001
0002 /***********************************************************************
0003 * Copyright 1998-2020 CERN for the benefit of the EvtGen authors       *
0004 *                                                                      *
0005 * This file is part of EvtGen.                                         *
0006 *                                                                      *
0007 * EvtGen is free software: you can redistribute it and/or modify       *
0008 * it under the terms of the GNU General Public License as published by *
0009 * the Free Software Foundation, either version 3 of the License, or    *
0010 * (at your option) any later version.                                  *
0011 *                                                                      *
0012 * EvtGen is distributed in the hope that it will be useful,            *
0013 * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
0014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
0015 * GNU General Public License for more details.                         *
0016 *                                                                      *
0017 * You should have received a copy of the GNU General Public License    *
0018 * along with EvtGen.  If not, see <https://www.gnu.org/licenses/>.     *
0019 ***********************************************************************/
0020
0021 #ifndef EVT_POINT_1D_HH
0022 #define EVT_POINT_1D_HH
0023
0024 // Point on a finite 1-D interval. isValid shows whether for a given specification,
0025 // the coordinate _value is inside the interval defined by _min, _max.
0026
0027 class EvtPoint1D final {
0028   public:
0029     EvtPoint1D();
0030     EvtPoint1D( double value );
0031     EvtPoint1D( double min, double max, double value );
0032
0033     bool isValid() const { return _valid; }
0034
0035     double value() const { return _value; }
0036
0037     void print() const;
0038
0039   private:
0040     double _min;    // interval minimum
0041     double _max;    // interval maximum
0042     double _value;
0043     bool _valid;    // valid point inside the interval?
0044 };
0045
0046 #endif