logic.h

Go to the documentation of this file.

/* Copyright (C) 2002-2012 Stefan Buehler  <sbuehler@ltu.se>

   This program 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 2, 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, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */

#ifndef logic_h
#define logic_h

#include "arts.h"
#include "matpackVII.h"

bool is_bool(const Index& x);

bool is_multiple(const Index& x, const Index& y);

bool is_size(ConstVectorView x, const Index& l);

bool is_size(ConstMatrixView x, const Index& r, const Index& c);

bool is_size(ConstTensor3View x,
             const Index& p,
             const Index& r,
             const Index& c);

bool is_size(ConstTensor4View x,
             const Index& b,
             const Index& p,
             const Index& r,
             const Index& c);

bool is_size(ConstTensor5View x,
             const Index& s,
             const Index& b,
             const Index& p,
             const Index& r,
             const Index& c);

bool is_size(ConstTensor6View x,
             const Index& v,
             const Index& s,
             const Index& b,
             const Index& p,
             const Index& r,
             const Index& c);

bool is_size(ConstTensor7View x,
             const Index& l,
             const Index& v,
             const Index& s,
             const Index& b,
             const Index& p,
             const Index& r,
             const Index& c);

bool is_sorted(ConstVectorView x);

bool is_increasing(ConstVectorView x);

bool is_increasing(const ArrayOfIndex& x);

bool is_decreasing(ConstVectorView x);

bool is_unique(const ArrayOfIndex& x);

bool is_singular(ConstMatrixView A);

bool is_diagonal(ConstMatrixView A);

bool is_same_within_epsilon(const Numeric& a,
                            const Numeric& b,
                            const Numeric& epsilon);

bool is_lon_cyclic(ConstVectorView grid, const Numeric& epsilon = 0.001);

//   Template functions (have to be here in the .h file).


template <class T>
bool is_size(const Array<T>& x, const Index& n) {
  return (n == x.nelem());
}

#endif  // logic_h