src/IO/Serialization.cpp

/*
* This file is part of MultiBoost, a multi-class 
* AdaBoost learner/classifier
*
* Copyright (C) 2005 Norman Casagrande
* For informations write to nova77@gmail.com
*
* 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.1 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*
*/

#include "IO/Serialization.h"
#include "Utils/Utils.h" // for cmp_nocase

#include <fstream> // input/output on file
#include <cctype> // for isspace

namespace MultiBoost {

// -----------------------------------------------------------------------

Serialization::Serialization(const string& shypFileName, const string& weakLearnerName)
: _shypFileName(shypFileName)
{
   // Clear file
   ofstream shypFile(shypFileName.c_str());

   // print the header
   shypFile << "<?xml version=\"1.0\"?>" << endl;
   shypFile << "<multiboost>" << endl;
   shypFile << standardTag("algo", weakLearnerName, 1) << endl;

}

// -----------------------------------------------------------------------

Serialization::~Serialization()
{
   // close tag
   ofstream shypFile(_shypFileName.c_str(), ios_base::app);
   shypFile << "</multiboost>" << endl;
}

// -----------------------------------------------------------------------

void Serialization::saveHypotheses(vector<BaseLearner*>& weakHypotheses)
{
   // save the weak hypotheses one by one.
   for (int i = 0; i < (int)weakHypotheses.size(); ++i)
      appendHypothesis(i, weakHypotheses[i]);
}

// -----------------------------------------------------------------------

void  Serialization::appendHypothesis(const int iteration, BaseLearner* pWeakHypothesis)
{
   // open in append mode
   ofstream shypFile(_shypFileName.c_str(), ios_base::app);

   // open the hypothesis tag
   shypFile << "\t<weakhyp iter=\"" << iteration << "\">" << endl;
   // save the hypothesis
   pWeakHypothesis->save(shypFile, 2); 
   // close the hypothesis tag
   shypFile << "\t</weakhyp>"<< endl;

   // add a separation "comment"
   shypFile << "\t<!-- ################################## -->" << endl;
}

// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------

void UnSerialization::loadHypotheses(const string& shypFileName, 
                                     vector<BaseLearner*>& weakHypotheses)
{
   // open file
   ifstream inFile(shypFileName.c_str());
   if (!inFile.is_open())
   {
      cerr << "ERROR: Cannot open strong hypothesis file <" << shypFileName << ">!" << endl;
      exit(1);
   }

   // Declares the stream tokenizer
   nor_utils::StreamTokenizer st(inFile, "<>\n\r\t");

   // Move until it finds the multiboost tag
   if ( !seekSimpleTag(st, "multiboost") )
   {
      // no multiboost tag found: this is not the correct file!
      cerr << "ERROR: Not a valid MultiBoost Strong Hypothesis file!!" << endl;
      exit(1);
   }

   // Move until it finds the algo tag
   string basicLearnerName = seekAndParseEnclosedValue<string>(st, "algo");

   // Check if the weak learner exists
   if ( !BaseLearner::RegisteredLearners().hasLearner(basicLearnerName) )
   {
      cerr << "ERROR: Weak learner <" << basicLearnerName << "> not registered!!" << endl;
      exit(1);
   }

   string rawTag;
   string tag, tagParam, tagValue;

   while (true)
   {
      // move until the next weak hypothesis
      if ( seekParamTag(st, "weakhyp") )
      {
         // allocate the weak learner object
         BaseLearner* pWeakHypothesis = 
            BaseLearner::RegisteredLearners().getLearner(basicLearnerName)->create();

         // load it
         pWeakHypothesis->load(st);

         // store it in the vector
         weakHypotheses.push_back(pWeakHypothesis);
      }
      else
         break;
   }

}

// -----------------------------------------------------------------------

bool UnSerialization::seekSimpleTag(nor_utils::StreamTokenizer& st, const string& tag)
{
   do{
      if ( nor_utils::cmp_nocase( st.next_token(), tag ) )
         return true;
   } while( st.has_token() );
   
   return false;   
}

// -----------------------------------------------------------------------

bool UnSerialization::seekParamTag(nor_utils::StreamTokenizer& st, const string& tag)
{

   do {
      // the full tag. I.e. <tag param="val">
      string rawTag = st.next_token();
      string tagOnly;
      string::const_iterator p = rawTag.begin();

      // get tag name
      insert_iterator<string> tagIt(tagOnly, tagOnly.begin());
      for ( ; p != rawTag.end(); ++p)
      {
         if ( isspace(*p) )
            break;
         *tagIt = *p;
      }

      // check if it is the one we are looking for
      if ( nor_utils::cmp_nocase( tagOnly, tag ) )
         return true;
      
   } while( st.has_token() );

   return false;
}

// -----------------------------------------------------------------------

void UnSerialization::parseParamTag(const string& str, string& tag, string& tagParam, string& paramValue)
{
   // simple tag. Return just the string
   if ( str.find('=') == string::npos )
   {
      tag = str;
      return;
   } 

   tag = "";
   tagParam = "";
   paramValue = "";

   string::const_iterator p = str.begin();

   // get tag name
   insert_iterator<string> tagIt(tag, tag.begin());
   for ( ; p != str.end(); ++p)
   {
      if ( isspace(*p) )
         break;
      *tagIt = *p;
   }

   // skip white spaces
   for ( ; isspace(*p) && p != str.end() ; ++p );

   // get param name
   insert_iterator<string> paramIt(tagParam, tagParam.begin());
   for ( ; p != str.end(); ++p)
   {
      if (*p == '=')
         break;
      *paramIt = *p;
   }

   // skip white spaces
   for ( ; p != str.end() && isspace(*p); ++p );
   // skip =
   for ( ; p != str.end() && *p == '='; ++p );
   // skip white spaces
   for ( ; p != str.end() && isspace(*p); ++p );

   // skip opening "
   for ( ; *p == '"' && p != str.end() ; ++p );

   // get param value
   insert_iterator<string> valueIt(paramValue, paramValue.begin());
   for ( ; p != str.end(); ++p)
   {
      if (*p == '\"')
         break;
      *valueIt = *p;
   }

}

// -----------------------------------------------------------------------

bool UnSerialization::seekAndParseParamTag(nor_utils::StreamTokenizer& st, const string& tag, string& tagParam, string& paramValue)
{
   bool tagFound = false;
   string rawTag;
   string foundTag;
   string::const_iterator p;

   tagParam = "";
   paramValue = "";

   do {

      // the full tag. I.e. <tag param="val">
      rawTag = st.next_token();
      foundTag = "";

      p = rawTag.begin();

      // get tag name
      insert_iterator<string> tagIt(foundTag, foundTag.begin());
      for ( ; p != rawTag.end(); ++p)
      {
         if ( isspace(*p) )
            break;
         *tagIt = *p;
      }

      if ( nor_utils::cmp_nocase(tag, foundTag) )
      {
         tagFound = true;
         break;
      }

   } while( st.has_token() );

   if ( !tagFound )
      return false;

   // skip white spaces
   for ( ; isspace(*p) && p != rawTag.end() ; ++p );

   // get param name
   insert_iterator<string> paramIt(tagParam, tagParam.begin());
   for ( ; p != rawTag.end(); ++p)
   {
      if (*p == '=')
         break;
      *paramIt = *p;
   }

   // skip white spaces
   for ( ; p != rawTag.end() && isspace(*p); ++p );
   // skip =
   for ( ; p != rawTag.end() && *p == '='; ++p );
   // skip white spaces
   for ( ; p != rawTag.end() && isspace(*p); ++p );

   // skip opening "
   for ( ; p != rawTag.end() && *p == '"'; ++p );

   // get param value
   insert_iterator<string> valueIt(paramValue, paramValue.begin());
   for ( ; p != rawTag.end(); ++p)
   {
      if (*p == '\"')
         break;
      *valueIt = *p;
   }

   return true;
}

// -----------------------------------------------------------------------

} // end of namespace MultiBoost

---