Term.h

/* 
 * File:   Term.h
 * 
 * Copyright 2012 Heinrich Schuchardt <xypron.glpk@gmx.de>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef TERM_H
#define TERM_H

#include <string>
#include <iostream>
#include <vector>
#include <set>
#include "ProblemMismatchException.h"
#include "TermValue.h"
#include "TermValueComperator.h"

class Problem;
class Term;
class TermVariable;

typedef std::vector<Term*> TermPointerVector;
typedef std::vector<double> DoubleVector;
typedef std::set<TermValue, TermValueComperator> TermValueSet;
typedef std::vector<TermVariable*> TermVariablePointerVector;

class Term {
    friend class Problem;
public:
    static const int INVALID_INDEX = -1;
    virtual Term* differentiate(TermVariable* variable) throw
    (ProblemMismatchException);
    double evaluate(
            const DoubleVector* variableValues);
    double evaluate(
            const DoubleVector* variableValues,
            TermValueSet* termValues);
    virtual Problem* getProblem() const;
    const int getTermIndex();
    virtual bool less(const Term* term) const;
    virtual std::string toString() const;
protected:
    virtual double eval(
            const DoubleVector* variableValues,
            TermValueSet* termValues);
    void setTermIndex(const int termIndex);
    Term(Problem* problem);
    virtual ~Term();
private:
    Problem* problem_;
    int termIndex_;
};

std::ostream& operator<<(std::ostream& outs, const Term* term);
#endif  /* TERM_H */