/*-------------------------------------------------------------------------------------*/
/*  NOMAD - Nonlinear Optimization by Mesh Adaptive Direct search - version 3.7.0        */
/*                                                                                     */
/*  Copyright (C) 2001-2014  Mark Abramson        - the Boeing Company, Seattle        */
/*                           Charles Audet        - Ecole Polytechnique, Montreal      */
/*                           Gilles Couture       - Ecole Polytechnique, Montreal      */
/*                           John Dennis          - Rice University, Houston           */
/*                           Sebastien Le Digabel - Ecole Polytechnique, Montreal      */
/*                           Christophe Tribes    - Ecole Polytechnique, Montreal      */
/*                                                                                     */
/*  funded in part by AFOSR and Exxon Mobil                                            */
/*                                                                                     */
/*  Author: Sebastien Le Digabel                                                       */
/*                                                                                     */
/*  Contact information:                                                               */
/*    Ecole Polytechnique de Montreal - GERAD                                          */
/*    C.P. 6079, Succ. Centre-ville, Montreal (Quebec) H3C 3A7 Canada                  */
/*    e-mail: nomad@gerad.ca                                                           */
/*    phone : 1-514-340-6053 #6928                                                     */
/*    fax   : 1-514-340-5665                                                           */
/*                                                                                     */
/*  This program 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 3 of the License, or (at your option) any later         */
/*  version.                                                                           */
/*                                                                                     */
/*  This program 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 program. If not, see <http://www.gnu.org/licenses/>.                     */
/*                                                                                     */
/*  You can find information on the NOMAD software at www.gerad.ca/nomad               */
/*-------------------------------------------------------------------------------------*/
/**
  \file   Cache_Point.hpp
  \brief  Point stored in the cache (headers)
  \author Sebastien Le Digabel
  \date   2010-04-08
  \see    Cache_Point.cpp
*/
#ifndef __CACHE_POINT__
#define __CACHE_POINT__

#include "Eval_Point.hpp"

namespace NOMAD {

  /// Class for the representation of NOMAD::Eval_Point objects stored in the cache.
  class Cache_Point : public NOMAD::Set_Element<NOMAD::Eval_Point> {

  private:

    /// Affectation operator.
    /**
       \param cp The right-hand side object -- \b IN.
       \return \c *this as the result of the affectation.
    */
    Cache_Point & operator = ( const Cache_Point & cp );

  public:

    /// Constructor.
    /**
       \param x A pointer to the NOMAD::Eval_Point object
                that is stored in the cache -- \b IN.
    */
    explicit Cache_Point ( const NOMAD::Eval_Point * x )
      : NOMAD::Set_Element<NOMAD::Eval_Point> ( x ) {}

    /// Copy constructor.
    /**
       \param cp The copied object -- \b IN.
    */
    Cache_Point ( const Cache_Point & cp )
      : NOMAD::Set_Element<NOMAD::Eval_Point> ( cp.get_element() ) {}

    /// Destructor.
    virtual ~Cache_Point ( void ) {}

    /// Comparison operator.
    /**
       \param  cp The right-hand side object.
       \return A boolean equal to \c true if \c *this \c < \c cp.
    */
    virtual bool operator < ( const NOMAD::Set_Element<NOMAD::Eval_Point> & cp ) const;

    /// Access to the point.
    /**
       \return A pointer to the NOMAD::Eval_Point stored in the cache.
    */
    const NOMAD::Eval_Point * get_point ( void ) const { return get_element(); }
  };
}

#endif
