// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-

//-----------------------------------------------------------------------------
// eoPopStat.h
// (c) Maarten Keijzer, Marc Schoenauer and GeNeura Team, 2001
/*
    This library 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 2 of the License, or (at your option) any later version.

    This library 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 library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    Contact: todos@geneura.ugr.es, http://geneura.ugr.es
             Marc.Schoenauer@polytechnique.fr
             mkeijzer@dhi.dk
 */
//-----------------------------------------------------------------------------

/** WARNING: this file contains 2 classes:

eoPopString and eoSortedPopString

that transform the population into a std::string
that can be used to dump to the screen
*/

#ifndef _eoPopStat_h
#define _eoPopStat_h

#include <utils/eoStat.h>


/** Thanks to MS/VC++, eoParam mechanism is unable to handle std::vectors of stats.
This snippet is a workaround:
This class will "print" a whole population into a std::string - that you can later
send to any stream
This is the plain version - see eoPopString for the Sorted version

Note: this Stat should probably be used only within eoStdOutMonitor, and not
inside an eoFileMonitor, as the eoState construct will work much better there.

@ingroup Stats
*/
template <class EOT>
class eoPopStat : public eoStat<EOT, std::string>
{
public:

    using eoStat<EOT, std::string>::value;

  /** default Ctor, void std::string by default, as it appears
      on the description line once at beginning of evolution. and
      is meaningless there. _howMany defaults to 0, that is, the whole
	  population*/
   eoPopStat(unsigned _howMany = 0, std::string _desc ="")
	 : eoStat<EOT, std::string>("", _desc), combien( _howMany) {}

/** Fills the value() of the eoParam with the dump of the population.
Adds a \n before so it does not get mixed up with the rest of the stats
that are written by the monitor it is probably used from.
*/
void operator()(const eoPop<EOT>& _pop)
{
  value() = "\n# ====== pop dump =====\n";
  unsigned howmany=combien?combien:_pop.size();
  for (unsigned i = 0; i < howmany; ++i)
  {
      std::ostringstream os;
      os << _pop[i] << std::endl;

      // paranoid:
      value() += os.str();
  }
}

private:
  unsigned combien;
};

/** Thanks to MS/VC++, eoParam mechanism is unable to handle std::vectors of stats.
This snippet is a workaround:
This class will "print" a whole population into a std::string - that you can later
send to any stream
This is the Sorted version - see eoPopString for the plain version

Note: this Stat should probably be used only within eoStdOutMonitor, and not
inside an eoFileMonitor, as the eoState construct will work much better there.

@ingroup Stats
*/
template <class EOT>
class eoSortedPopStat : public eoSortedStat<EOT, std::string>
{
public:

    using eoSortedStat<EOT, std::string>::value;

    /** default Ctor, void std::string by default, as it appears on
        the description line once at beginning of evolution. and is
        meaningless there _howMany defaults to 0, that is, the whole
        population
    */
    eoSortedPopStat(unsigned _howMany = 0, std::string _desc ="")
        : eoSortedStat<EOT, std::string>("", _desc) , combien( _howMany)
        {}

    /** Fills the value() of the eoParam with the dump of the
        population. Adds a \n before so it does not get mixed up with
        the rest of the stats that are written by the monitor it is
        probably used from.
    */
    void operator()(const std::vector<const EOT*>& _pop)
        {
    value() = "";		   // empty
    unsigned howMany=combien?combien:_pop.size();
    for (unsigned i = 0; i < howMany; ++i)
      {
	std::ostringstream os;
	os << *_pop[i] << std::endl;

	// paranoid:
	value() += os.str();
      }
  }
private:
  unsigned combien;
};

#endif