ginac/fail.h

   1 /** @file fail.h
   2  *
   3  *  Interface to class signaling failure of operation. Considered obsolete
   4  *  somewhat obsolete (most of this can be replaced by exceptions). */
   5
   6 /*
   7  *  GiNaC Copyright (C) 1999-2002 Johannes Gutenberg University Mainz, Germany
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #ifndef __GINAC_FAIL_H__
  25 #define __GINAC_FAIL_H__
  26
  27 #include "basic.h"
  28
  29 namespace GiNaC {
  30
  31 class fail : public basic
  32 {
  33         GINAC_DECLARE_REGISTERED_CLASS(fail, basic)
  34
  35         // functions overriding virtual functions from base classes
  36 public:
  37         void print(const print_context & c, unsigned level = 0) const;
  38 protected:
  39         unsigned return_type(void) const { return return_types::noncommutative_composite; };
  40 };
  41
  42 /** Specialization of is_exactly_a<fail>(obj) for fail objects. */
  43 template<> inline bool is_exactly_a<fail>(const basic & obj)
  44 {
  45         return obj.tinfo()==TINFO_fail;
  46 }
  47
  48 } // namespace GiNaC
  49
  50 #endif // ndef __GINAC_FAIL_H__