STK_NotAvailable.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

    This program 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 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA

    Contact : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  Base
 * Purpose:  Define the fundamental type NotAvailable.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_NOTAVAILABLE_H
#define STK_NOTAVAILABLE_H

#include "STK_Arithmetic.h"
#include "STK_IdTypeImpl.h"
#include "STK_Stream.h"
#include "STK_Proxy.h"

namespace STK
{
enum NotAvailable
{ missing };

template<>
struct Arithmetic<NotAvailable> : public std::numeric_limits<NotAvailable>
{
  static NotAvailable NA() throw()
  { return missing;}

  static const bool hasNA = true;

  static bool isNA(const NotAvailable& x) throw()
  { return true;}
    
  static bool isInfinite(const NotAvailable& x) throw()
  { return false; }

  static bool isFinite(const NotAvailable& x) throw()
  { return false;}
};

template<>
struct IdTypeImpl<NotAvailable>
{
  static IdType returnType()
  { return(notavailable);}
};

ostream& operator << (ostream& os, const NotAvailable& output);

istream& operator >> (istream& is, Proxy<NotAvailable>& input);

} // namespace STK

#endif /* STK_NOTAVAILABLE_H */