/*
 * scrm is an implementation of the Sequential-Coalescent-with-Recombination Model.
 * 
 * Copyright (C) 2013, 2014 Paul R. Staab, Sha (Joe) Zhu, Dirk Metzler and Gerton Lunter
 * 
 * This file is part of scrm.
 * 
 * scrm 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 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef scrm_src_summary_statistic_summary_statistic
#define scrm_src_summary_statistic_summary_statistic

#include <iostream>
#include <ostream>

class Forest;

class SummaryStatistic 
{
 public:
   virtual ~SummaryStatistic() {};

   // Virtual methods
   virtual void calculate(const Forest &forest) =0;
   virtual void clear() =0;
   virtual SummaryStatistic* clone() const =0; 

   // Optional methods
   virtual void printLocusOutput(std::ostream &output) const { (void) output; };
   virtual void printSegmentOutput(std::ostream &output) const { (void) output; };
};

#endif
