/usr/include/openturns/Interval.hxx is in libopenturns-dev 0.15-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | // -*- C++ -*-
/**
* @file Interval.hxx
* @brief Interval is defined as the cartesian product of n 1D intervalls ]low_1, up_1]x...x]low_n,up_n]
*
* (C) Copyright 2005-2011 EDF-EADS-Phimeca
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: souchaud $
* @date: $LastChangedDate: 2011-07-01 10:34:36 +0200 (Fri, 01 Jul 2011) $
* Id: $Id: Interval.hxx 1981 2011-07-01 08:34:36Z souchaud $
*/
#ifndef OPENTURNS_INTERVAL_HXX
#define OPENTURNS_INTERVAL_HXX
#include "PersistentObject.hxx"
#include "Exception.hxx"
#include "Collection.hxx"
#include "PersistentCollection.hxx"
#include "NumericalPoint.hxx"
namespace OpenTURNS {
namespace Base {
namespace Type {
/**
* @class Interval
*
* A class that holds a collection of interval
*/
class Interval
: public Common::PersistentObject
{
CLASSNAME;
public:
typedef Type::Collection<UnsignedLong> BoolCollection;
typedef Type::PersistentCollection<UnsignedLong> BoolPersistentCollection;
typedef Common::InvalidArgumentException InvalidArgumentException;
typedef Common::PersistentObject PersistentObject;
typedef Base::Common::StorageManager StorageManager;
/** Default constructor */
explicit Interval(const UnsignedLong dimension = 1);
/** Parameters constructor, simplified for 1D case */
Interval(const NumericalScalar lowerBound,
const NumericalScalar upperBound);
/** Parameters constructor */
Interval(const NumericalPoint & lowerBound,
const NumericalPoint & upperBound)
/* throw(InvalidArgumentException) */;
/** Parameters constructor */
Interval(const NumericalPoint & lowerBound,
const NumericalPoint & upperBound,
const BoolCollection & finiteLowerBound,
const BoolCollection & finiteUpperBound)
/* throw(InvalidArgumentException) */;
/** Virtual constructor method */
Interval * clone() const;
/** Check if the interval is empty, i.e. if we have lowerBound >= upperBound for at least one component */
Bool isEmpty() const;
/** Check if the interval is numerically empty, i.e. if we have lowerBound >= upperBound for at least one component */
Bool isNumericallyEmpty() const;
/** Check if the given point is inside of the closed interval */
Bool isInside(const NumericalPoint & point) const;
/** Check if the given point is numerically inside of the closed interval, i.e. using only the bounds part of the interval */
Bool isNumericallyInside(const NumericalPoint & point) const;
/** Get the numerical volume of the interval */
NumericalScalar getNumericalVolume() const;
/** Returns the interval equals to the intersection between the interval and another one */
Interval intersect(const Interval & other) const;
/** Returns the interval equals to the union between the interval and another one */
Interval join(const Interval & other) const;
/** Addition operator */
Interval operator +(const Interval & rhs) const
/* throw (InvalidArgumentException) */;
/** Substraction operator */
Interval operator -(const Interval & rhs) const
/* throw (InvalidArgumentException) */;
/** In-place addition operator */
Interval & operator +=(const Interval & other) /* throw (InvalidArgumentException) */;
/** In-place substraction operator */
Interval & operator -=(const Interval & other) /* throw (InvalidArgumentException) */;
/** Product operator */
Interval operator *(const NumericalScalar scalar) const;
/** In-place product operator */
Interval & operator *=(const NumericalScalar scalar);
/** Comparison operator */
Bool operator == (const Interval & rhs) const ;
/** Dimension accessor */
UnsignedLong getDimension() const;
/** Lower bound accessor */
NumericalPoint getLowerBound() const;
void setLowerBound(const NumericalPoint & lowerBound);
/** Upper bound accessor */
NumericalPoint getUpperBound() const;
void setUpperBound(const NumericalPoint & upperBound);
/** Lower bound flag accessor */
BoolCollection getFiniteLowerBound() const;
void setFiniteLowerBound(const BoolCollection & finiteLowerBound);
/** Upper bound flag accessor */
BoolCollection getFiniteUpperBound() const;
void setFiniteUpperBound(const BoolCollection & finiteUpperBound);
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/** Method save() stores the object through the StorageManager */
virtual void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
virtual void load(StorageManager::Advocate & adv);
private:
// Dimension of the interval
UnsignedLong dimension_;
// An n-D intervall is defined as the cartesian product of n 1D intervalls ]low_1, up_1]x...x]low_n,up_n]
NumericalPoint lowerBound_;
NumericalPoint upperBound_;
// Flags that tell if the bounds are finite or not.
// The bound is finite if the flag is true, else it is equal to -inf if the associated value is < 0, +inf else
BoolPersistentCollection finiteLowerBound_;
BoolPersistentCollection finiteUpperBound_;
}; /* class Interval */
} /* Namespace Type */
} /* Namespace Base */
} /* Namespace OpenTURNS */
#endif /* OPENTURNS_INTERVAL_HXX */
|