share/Errors.cxx

// Copyright (C) 2001-2009 Vivien Mallet
//
// This file is part of the linear-algebra library Seldon,
// http://seldon.sourceforge.net/.
//
// Seldon 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.
//
// Seldon 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 Seldon. If not, see http://www.gnu.org/licenses/.


#ifndef SELDON_FILE_ERRORS_CXX

#include "Errors.hxx"

namespace Seldon
{


  // ERROR //


  /****************
   * CONSTRUCTORS *
   ****************/



  Error::Error(string function, string comment):
    description_("ERROR!\nAn undefined error occurred"),
    function_(function), comment_(comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  Error::Error(string description, string function, string comment):
    description_("ERROR!\n" + description),
    function_(function), comment_(comment)
  {
  }


  /**************
   * DESTRUCTOR *
   **************/



  Error::~Error()
  {
  }


  /***********
   * METHODS *
   ***********/



  string Error::What()
  {
    string message(description_);
    if (!function_.empty())
      message += " in " + function_;
    message += ".\n";
    if (!comment_.empty())
      message += "   " + comment_;
    return message;
  }



  void Error::CoutWhat()
  {
    cout << this->What() << endl;
  }



  // UNDEFINED //



  Undefined::Undefined(string function, string comment):
  Error("", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  string Undefined::What()
  {
    string message;
    if (!this->function_.empty())
      message = this->function_;
    else
      message = "A function or a method";
    message += " is undefined.\nEither its implementation is missing,"
      + string(" or it does not make sense or it is impossible ")
      + "to implement it.\n";
    if (!this->comment_.empty())
      message += "   " + this->comment_;
    return message;
  }


  // WRONGARGUMENT //



  WrongArgument::WrongArgument(string function, string comment):
  Error("Wrong argument given to ", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  string WrongArgument::What()
  {
    string message(this->description_);
    if (!this->function_.empty())
      message += this->function_;
    message += ".\n";
    if (!this->comment_.empty())
      message += "   " + this->comment_;
    return message;
  }


  // NOMEMORY //



  NoMemory::NoMemory(string function, string comment):
    Error("Out of memory", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  // WRONGDIM //



  WrongDim::WrongDim(string function, string comment):
    Error("Wrong dimensions involved", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  // WRONGINDEX //



  WrongIndex::WrongIndex(string function, string comment):
    Error("Index out of range", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  // WRONGROW //



  WrongRow::WrongRow(string function, string comment):
    Error("Row index out of range", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  // WRONGCOL //



  WrongCol::WrongCol(string function, string comment):
    Error("Column index out of range", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  // IOERROR //



  IOError::IOError(string function, string comment):
    Error("Error while performing an I/O operation", function, comment)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  // LAPACKERROR //



  LapackError::LapackError(int info, string function, string comment):
  Error("Error returned by Lapack", function, comment), info_(info)
  {
#ifdef SELDON_WITH_ABORT
    this->CoutWhat();
    abort();
#endif
  }



  string LapackError::What()
  {
    string message(this->description_);
    if (!this->function_.empty())
      message += " in " + this->function_;
    message += ".\n";
    if (!this->comment_.empty())
      message += "   " + this->comment_;
    message += "   Diagnostic integer (\"info\"): " + to_str(info_)
      + ".\n";
    return message;
  }


  // LAPACKINFO //


  LapackInfo::LapackInfo(int info): info_(info)
  {
  }


  LapackInfo::operator int ()
  {
    return info_;
  }


  int LapackInfo::GetInfo()
  {
    return info_;
  }


  int& LapackInfo::GetInfoRef()
  {
    return info_;
  }


#ifndef SELDON_WITH_COMPILED_LIBRARY
  LapackInfo lapack_info(0);
#endif


} // namespace Seldon.

#define SELDON_FILE_ERRORS_CXX
#endif