view liboctave/Objective.h @ 1667:f1b5a5086e46

[project @ 1995-12-26 04:14:18 by jwe]
author jwe
date Tue, 26 Dec 1995 04:15:08 +0000
parents 26411f9c7603
children 620a65533630
line wrap: on
line source

// Objective.h                                          -*- C++ -*-
/*

Copyright (C) 1992, 1993, 1994, 1995 John W. Eaton

This file is part of Octave.

Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.

Octave 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 General Public License
for more details.

You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING.  If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#if !defined (octave_Objective_h)
#define octave_Objective_h 1

#include "dColVector.h"

class Objective
{
 public:

  typedef double (*objective_fcn) (const ColumnVector&);
  typedef ColumnVector (*gradient_fcn) (const ColumnVector&);

  Objective (void)
    {
      phi = 0;
      grad = 0;
    }

  Objective (const objective_fcn obj)
    {
      phi = obj;
      grad = 0;
    }

  Objective (const objective_fcn obj, const gradient_fcn g)
    {
      phi = obj;
      grad = g;
    }

  Objective (const Objective& a)
    {
      phi = a.phi;
      grad = a.grad;
    }

  Objective& operator = (const Objective& a)
    {
      phi = a.phi;
      grad = a.grad;

      return *this;
    }

  objective_fcn objective_function (void) const { return phi; }

  Objective& set_objective_function (const objective_fcn obj)
    {
      phi = obj;
      return *this;
    }

  gradient_fcn gradient_function (void) const { return grad; }

  Objective& set_gradient_function (const gradient_fcn g)
    {
      grad = g;
      return *this;
    }

 private:

  objective_fcn phi;
  gradient_fcn grad;

};

#endif

/*
;;; Local Variables: ***
;;; mode: C++ ***
;;; page-delimiter: "^/\\*" ***
;;; End: ***
*/