/usr/include/coin/ClpConstraint.hpp is in coinor-libclp-dev 1.15.10-1build2.
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 | /* $Id: ClpConstraint.hpp 1665 2011-01-04 17:55:54Z lou $ */
// Copyright (C) 2007, International Business Machines
// Corporation and others. All Rights Reserved.
// This code is licensed under the terms of the Eclipse Public License (EPL).
#ifndef ClpConstraint_H
#define ClpConstraint_H
//#############################################################################
class ClpSimplex;
class ClpModel;
/** Constraint Abstract Base Class
Abstract Base Class for describing a constraint or objective function
*/
class ClpConstraint {
public:
///@name Stuff
//@{
/** Fills gradient. If Linear then solution may be NULL,
also returns true value of function and offset so we can use x not deltaX in constraint
If refresh is false then uses last solution
Uses model for scaling
Returns non-zero if gradient undefined at current solution
*/
virtual int gradient(const ClpSimplex * model,
const double * solution,
double * gradient,
double & functionValue ,
double & offset,
bool useScaling = false,
bool refresh = true) const = 0;
/// Constraint function value
virtual double functionValue (const ClpSimplex * model,
const double * solution,
bool useScaling = false,
bool refresh = true) const ;
/// Resize constraint
virtual void resize(int newNumberColumns) = 0;
/// Delete columns in constraint
virtual void deleteSome(int numberToDelete, const int * which) = 0;
/// Scale constraint
virtual void reallyScale(const double * columnScale) = 0;
/** Given a zeroed array sets nonlinear columns to 1.
Returns number of nonlinear columns
*/
virtual int markNonlinear(char * which) const = 0;
/** Given a zeroed array sets possible nonzero coefficients to 1.
Returns number of nonzeros
*/
virtual int markNonzero(char * which) const = 0;
//@}
///@name Constructors and destructors
//@{
/// Default Constructor
ClpConstraint();
/// Copy constructor
ClpConstraint(const ClpConstraint &);
/// Assignment operator
ClpConstraint & operator=(const ClpConstraint& rhs);
/// Destructor
virtual ~ClpConstraint ();
/// Clone
virtual ClpConstraint * clone() const = 0;
//@}
///@name Other
//@{
/// Returns type, 0 linear, 1 nonlinear
inline int type() {
return type_;
}
/// Row number (-1 is objective)
inline int rowNumber() const {
return rowNumber_;
}
/// Number of possible coefficients in gradient
virtual int numberCoefficients() const = 0;
/// Stored constraint function value
inline double functionValue () const {
return functionValue_;
}
/// Constraint offset
inline double offset () const {
return offset_;
}
/// Say we have new primal solution - so may need to recompute
virtual void newXValues() {}
//@}
//---------------------------------------------------------------------------
protected:
///@name Protected member data
//@{
/// Gradient at last evaluation
mutable double * lastGradient_;
/// Value of non-linear part of constraint
mutable double functionValue_;
/// Value of offset for constraint
mutable double offset_;
/// Type of constraint - linear is 1
int type_;
/// Row number (-1 is objective)
int rowNumber_;
//@}
};
#endif
|