/usr/include/coin/MP_constant.hpp is in coinor-libflopc++-dev 1.0.6-3.1+b1.
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 174 175 176 177 178 179 180 | // ******************** FlopCpp **********************************************
// File: MP_constant.hpp
// $Id$
// Author: Tim Helge Hultberg (thh@mat.ua.pt)
// Copyright (C) 2003 Tim Helge Hultberg
// All Rights Reserved.
// ****************************************************************************
#ifndef _MP_constant_hpp_
#define _MP_constant_hpp_
#include "MP_utilities.hpp"
namespace flopc {
/** @brief Base class for all "constant" types of data.
@ingroup INTERNAL_USE
@note FOR INTERNAL USE: This is not normally used directly by the
calling code.
*/
class Constant_base {
friend class Constant;
friend class Handle<Constant_base*>;
public:
virtual double evaluate() const = 0;
virtual int getStage() const {
return 0;
}
virtual int stage() const {
return 0;
}
protected:
Constant_base() : count(0) {}
virtual ~Constant_base() {}
int count;
};
class MP_index_exp;
class DataRef;
class MP_domain;
/** @brief Reference counted class for all "constant" types of data.
@ingroup INTERNAL_USE
@note FOR INTERNAL USE: This is not normally used directly by the calling
code.
This contains counters to ConstantBase pointers.
These pointers may be of any of the Constant_base * type.
*/
class Constant : public Handle<Constant_base*> {
public:
Constant(const MP_index_exp& i);
Constant(const DataRef& d);
Constant(double d);
Constant(int d);
// operator-();
// private:
Constant(Constant_base* r) : Handle<Constant_base*>(r) {}
};
Constant operator-(const Constant& a);
/** @brief for computing the absolute value of a constant value.
@ingroup PublicInterface
This is used in the normal formation of an expression such as abs(-5)
@li input is a constant. It cannot be a variable expression.
@li Returns a Constant evaluating to the absolute value of the parameter
*/
Constant abs(const Constant& c);
/** @brief for returning non-negative value of the constant.
@ingroup PublicInterface
This is used in the formation of an expression. It is used to return
a non-negative value..
@param c an imput constant
@return the absolute value of the constant.
@li if the Constant is positive, it returns a positive number.
@li if the Constant is negative or zero, it returns 0.0
*/
Constant pos(const Constant& c);
/** @brief The ceiling integral value of the input constant.
@ingroup PublicInterface
This is used in the formation of an expression. It is used to "round up"
a numeric constant which is potentially non-integer.
@param c is a constant
@return the ceiling or "rounded up" of the parameter
@li ceil(3.2) evaluates to 4.0
*/
Constant ceil(const Constant& c);
/** @brief The floor integral value of the input constant.
@ingroup PublicInterface
This is used in the formation of an expression. It is used to "truncate"
a numeric constant which is potentially non-integer.
@param c is a constant
@return the floor or "truncated" value of the parameter
@li floor(3.7) evaluates to 3.0
*/
Constant floor(const Constant& c);
/** @brief Returns the smaller of two constants.
@ingroup PublicInterface
This is used in the formation of an expression.
@param a first constant
@param b second constant
@return the lesser of the two values.
@li minimum(3.6,3.7) evaluates to 3.6
*/
Constant minimum(const Constant& a, const Constant& b);
/** @brief Returns the larger of two constants.
@ingroup PublicInterface
This is used in the formation of an expression.
@param a first constant
@param b second constant
@return the greater of the two numbers
@li maximum(3.6,3.7) evaluates to 3.7
*/
Constant maximum(const Constant& a, const Constant& b);
/** @brief Returns the sum of two constants.
@ingroup PublicInterface
This is used in the formation of an expression.
@param a first constant
@param b second constant
@return the sum of the constants.
*/
Constant operator+(const Constant& a, const Constant& b);
/** @brief Returns the difference of two constants.
@ingroup PublicInterface
This is used in the formation of an expression.
@param a first constant
@param b second constant
@return the difference between the constants.
*/
Constant operator-(const Constant& a, const Constant& b);
/** @brief Returns the product of two constants.
@ingroup PublicInterface
This is used in the formation of an expression.
@param a first constant
@param b second constant
@return the result of multiplying the constants.
*/
Constant operator*(const Constant& a, const Constant& b);
/** @brief Returns the quotient of two constants.
@ingroup PublicInterface
This is used in the formation of an expression.
@param a first constant
@param b second constant
@return the result of dividing the first parameter by the second.
*/
Constant operator/(const Constant& a, const Constant& b);
class MP_boolean;
Constant mpif(const MP_boolean& c, const Constant& a, const Constant& b);
/** @brief Returns the maximum over the domain of the constant.
@ingroup PublicInterface
@todo description? Haven't used this.
@param i MP_domain used in evaluation
@param e constant
*/
Constant maximum(const MP_domain& i, const Constant& e);
/** @brief Returns the sum of two constants.
@ingroup PublicInterface
@todo description? Haven't used this.
@param i MP_domain used in evaluation
@param e second constant
*/
Constant minimum(const MP_domain& i, const Constant& e);
/** @brief Returns the sum of two constants.
@ingroup PublicInterface
@todo description? Haven't used this.
@param i MP_domain used in evaluation
@param e constant
*/
Constant sum(const MP_domain& i, const Constant& e);
/** @brief Returns the sum of two constants.
@ingroup PublicInterface
@todo description? Haven't used this.
@param i MP_domain used in evaluation
@param e constant
*/
Constant product(const MP_domain& i, const Constant& e);
} // End of namespace flopc
#endif
|