/*---------------------------------------------------------------------------------*/
/*  NOMAD - Nonlinear Optimization by Mesh Adaptive Direct Search -                */
/*                                                                                 */
/*  NOMAD - Version 4 has been created and developed by                            */
/*                 Viviane Rochon Montplaisir  - Polytechnique Montreal            */
/*                 Christophe Tribes           - Polytechnique Montreal            */
/*                                                                                 */
/*  The copyright of NOMAD - version 4 is owned by                                 */
/*                 Charles Audet               - Polytechnique Montreal            */
/*                 Sebastien Le Digabel        - Polytechnique Montreal            */
/*                 Viviane Rochon Montplaisir  - Polytechnique Montreal            */
/*                 Christophe Tribes           - Polytechnique Montreal            */
/*                                                                                 */
/*  NOMAD 4 has been funded by Rio Tinto, Hydro-Québec, Huawei-Canada,             */
/*  NSERC (Natural Sciences and Engineering Research Council of Canada),           */
/*  InnovÉÉ (Innovation en Énergie Électrique) and IVADO (The Institute            */
/*  for Data Valorization)                                                         */
/*                                                                                 */
/*  NOMAD v3 was created and developed by Charles Audet, Sebastien Le Digabel,     */
/*  Christophe Tribes and Viviane Rochon Montplaisir and was funded by AFOSR       */
/*  and Exxon Mobil.                                                               */
/*                                                                                 */
/*  NOMAD v1 and v2 were created and developed by Mark Abramson, Charles Audet,    */
/*  Gilles Couture, and John E. Dennis Jr., and were funded by AFOSR and           */
/*  Exxon Mobil.                                                                   */
/*                                                                                 */
/*  Contact information:                                                           */
/*    Polytechnique Montreal - GERAD                                               */
/*    C.P. 6079, Succ. Centre-ville, Montreal (Quebec) H3C 3A7 Canada              */
/*    e-mail: nomad@gerad.ca                                                       */
/*                                                                                 */
/*  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           */
/*---------------------------------------------------------------------------------*/
#ifndef __NOMAD_4_5_USERPOLLMETHOD__
#define __NOMAD_4_5_USERPOLLMETHOD__

#include "../../Algos/Mads/PollMethodBase.hpp"

#include "../../nomad_nsbegin.hpp"

/// Class UserPollMethod: Poll method defined by user.
///  Two variants are available. A regular and a free poll.
///  For both, generated trial points are combined with other 
//   poll methods.
///  Free poll trial points are not snap to bounds or to mesh.
class UserPollMethod: public PollMethodBase
{
public:
    /// Constructor
    /**
     \param parentStep      The parent of this search step -- \b IN.
     */
    explicit UserPollMethod(const Step* parentStep,
                            const EvalPointPtr frameCenter,
                            bool isFreePoll)
    : PollMethodBase(parentStep, frameCenter, false /*not second pass*/, isFreePoll)
    {
        init();
    }

    /// Intermediate to call user callback function. Only for user free poll method. Called once when user free poll methods have generated and evaluated (opportunistically) trial points. Can be used to revert modifications on the fixed variables.
    virtual void updateEndUserPoll() override;

private:

    /// Helper for constructor
    void init();

    /// The user poll method works only in the second pass.
    /**
     - It cannot be the only poll method.
     - It cannot be combined with a two passes regular method (like ortho n+1)
     - It can accept null direction in the subspace and only modify .
     \param directions  The directions obtained for this poll -- \b OUT.
      */
    void generateUnitPollDirections(std::list<Direction> &directions, const size_t n) const override final;
};

#include "../../nomad_nsend.hpp"

#endif // __NOMAD_4_5_USERPOLLMETHOD__
