ov-bool.h

Go to the documentation of this file.
00001 /*
00002 
00003 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005, 2006,
00004               2007, 2008 John W. Eaton
00005 
00006 This file is part of Octave.
00007 
00008 Octave is free software; you can redistribute it and/or modify it
00009 under the terms of the GNU General Public License as published by the
00010 Free Software Foundation; either version 3 of the License, or (at your
00011 option) any later version.
00012 
00013 Octave is distributed in the hope that it will be useful, but WITHOUT
00014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00015 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00016 for more details.
00017 
00018 You should have received a copy of the GNU General Public License
00019 along with Octave; see the file COPYING.  If not, see
00020 <http://www.gnu.org/licenses/>.
00021 
00022 */
00023 
00024 #if !defined (octave_bool_h)
00025 #define octave_bool_h 1
00026 
00027 #include <cstdlib>
00028 
00029 #include <iosfwd>
00030 #include <string>
00031 
00032 #include "lo-utils.h"
00033 #include "mx-base.h"
00034 #include "oct-alloc.h"
00035 #include "str-vec.h"
00036 
00037 #include "oct-stream.h"
00038 #include "ov-base.h"
00039 #include "ov-base-scalar.h"
00040 #include "ov-scalar.h"
00041 #include "ov-typeinfo.h"
00042 
00043 class Octave_map;
00044 class octave_value_list;
00045 
00046 class tree_walker;
00047 
00048 // Real scalar values.
00049 
00050 class
00051 octave_bool : public octave_base_scalar<bool>
00052 {
00053 public:
00054 
00055   octave_bool (void)
00056     : octave_base_scalar<bool> (false) { }
00057 
00058   octave_bool (bool b)
00059     : octave_base_scalar<bool> (b) { }
00060 
00061   octave_bool (const octave_bool& s)
00062     : octave_base_scalar<bool> (s) { }
00063 
00064   ~octave_bool (void) { }
00065 
00066   octave_base_value *clone (void) const { return new octave_bool (*this); }
00067   octave_base_value *empty_clone (void) const { return new octave_bool (); }
00068 
00069   type_conv_info numeric_conversion_function (void) const;
00070 
00071   octave_value do_index_op (const octave_value_list& idx,
00072                             bool resize_ok = false);
00073 
00074   idx_vector index_vector (void) const { return idx_vector (scalar); }
00075 
00076   builtin_type_t builtin_type (void) const { return btyp_bool; }
00077 
00078   bool is_real_scalar (void) const { return true; }
00079 
00080   bool is_bool_scalar (void) const { return true; }
00081 
00082   bool is_bool_type (void) const { return true; }
00083 
00084   bool is_real_type (void) const { return true; }
00085 
00086   bool is_true (void) const { return scalar; }
00087 
00088   int8NDArray
00089   int8_array_value (void) const
00090     { return int8NDArray (dim_vector (1, 1), scalar); }
00091 
00092   int16NDArray
00093   int16_array_value (void) const
00094     { return int16NDArray (dim_vector (1, 1), scalar); }
00095 
00096   int32NDArray
00097   int32_array_value (void) const
00098     { return int32NDArray (dim_vector (1, 1), scalar); }
00099 
00100   int64NDArray
00101   int64_array_value (void) const
00102     { return int64NDArray (dim_vector (1, 1), scalar); }
00103 
00104   uint8NDArray
00105   uint8_array_value (void) const
00106     { return uint8NDArray (dim_vector (1, 1), scalar); }
00107 
00108   uint16NDArray
00109   uint16_array_value (void) const
00110     { return uint16NDArray (dim_vector (1, 1), scalar); }
00111 
00112   uint32NDArray
00113   uint32_array_value (void) const
00114     { return uint32NDArray (dim_vector (1, 1), scalar); }
00115 
00116   uint64NDArray
00117   uint64_array_value (void) const
00118     { return uint64NDArray (dim_vector (1, 1), scalar); }
00119 
00120   double double_value (bool = false) const { return scalar; }
00121 
00122   float float_value (bool = false) const { return scalar; }
00123 
00124   double scalar_value (bool = false) const { return scalar; }
00125 
00126   float float_scalar_value (bool = false) const { return scalar; }
00127 
00128   Matrix matrix_value (bool = false) const
00129     { return Matrix (1, 1, scalar); }
00130 
00131   FloatMatrix float_matrix_value (bool = false) const
00132     { return FloatMatrix (1, 1, scalar); }
00133 
00134   NDArray array_value (bool = false) const
00135     { return NDArray (dim_vector (1, 1), static_cast<double> (scalar)); }
00136 
00137   FloatNDArray float_array_value (bool = false) const
00138     { return FloatNDArray (dim_vector (1, 1), static_cast<double> (scalar)); }
00139 
00140   Complex complex_value (bool = false) const { return scalar; }
00141 
00142   FloatComplex float_complex_value (bool = false) const { return scalar; }
00143 
00144   ComplexMatrix complex_matrix_value (bool = false) const
00145     { return ComplexMatrix (1, 1, Complex (scalar)); }
00146 
00147   FloatComplexMatrix float_complex_matrix_value (bool = false) const
00148     { return FloatComplexMatrix (1, 1, FloatComplex (scalar)); }
00149 
00150   ComplexNDArray complex_array_value (bool = false) const
00151     { return ComplexNDArray (dim_vector (1, 1), Complex (scalar)); }
00152 
00153   FloatComplexNDArray float_complex_array_value (bool = false) const
00154     { return FloatComplexNDArray (dim_vector (1, 1), FloatComplex (scalar)); }
00155 
00156   SparseMatrix sparse_matrix_value (bool = false) const
00157     { return SparseMatrix (Matrix (1, 1, scalar)); }
00158 
00159   // FIXME Need SparseComplexMatrix (Matrix) constructor!!!
00160   SparseComplexMatrix sparse_complex_matrix_value (bool = false) const
00161     { return SparseComplexMatrix (sparse_matrix_value ()); }
00162 
00163   SparseBoolMatrix sparse_bool_matrix_value (bool = false) const
00164     { return SparseBoolMatrix (boolMatrix (1, 1, scalar)); }
00165 
00166   charNDArray
00167   char_array_value (bool = false) const
00168   {
00169     charNDArray retval (dim_vector (1, 1));
00170     retval(0) = static_cast<char> (scalar);
00171     return retval;
00172   }
00173 
00174   bool bool_value (bool = false) const { return scalar; }
00175 
00176   boolMatrix bool_matrix_value (bool = false) const
00177     { return boolMatrix (1, 1, scalar); }
00178 
00179   boolNDArray bool_array_value (bool = false) const
00180     { return boolNDArray (dim_vector (1, 1), scalar); }
00181 
00182   octave_value resize (const dim_vector& dv, bool fill = false) const;
00183 
00184   octave_value convert_to_str_internal (bool pad, bool force, char type) const;
00185 
00186   bool save_ascii (std::ostream& os);
00187 
00188   bool load_ascii (std::istream& is);
00189 
00190   bool save_binary (std::ostream& os, bool& save_as_floats);
00191 
00192   bool load_binary (std::istream& is, bool swap, 
00193                     oct_mach_info::float_format fmt);
00194 
00195 #if defined (HAVE_HDF5)
00196   bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats);
00197 
00198   bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug);
00199 #endif
00200 
00201   int write (octave_stream& os, int block_size,
00202              oct_data_conv::data_type output_type, int skip,
00203              oct_mach_info::float_format flt_fmt) const
00204     {
00205       return os.write (bool_array_value (), block_size, output_type,
00206                        skip, flt_fmt);
00207     }
00208 
00209   mxArray *as_mxArray (void) const;
00210 
00211   // Mapper functions are converted to double for treatment
00212 #define BOOL_MAPPER(MAP) \
00213   octave_value MAP (void) const \
00214     { \
00215       octave_scalar s (static_cast<double> (scalar)); \
00216       return s.MAP (); \
00217     }
00218 
00219   BOOL_MAPPER (abs)
00220   BOOL_MAPPER (acos)
00221   BOOL_MAPPER (acosh)
00222   BOOL_MAPPER (angle)
00223   BOOL_MAPPER (arg)
00224   BOOL_MAPPER (asin)
00225   BOOL_MAPPER (asinh)
00226   BOOL_MAPPER (atan)
00227   BOOL_MAPPER (atanh)
00228   BOOL_MAPPER (ceil)
00229   BOOL_MAPPER (conj)
00230   BOOL_MAPPER (cos)
00231   BOOL_MAPPER (cosh)
00232   BOOL_MAPPER (erf)
00233   BOOL_MAPPER (erfc)
00234   BOOL_MAPPER (exp)
00235   BOOL_MAPPER (expm1)
00236   BOOL_MAPPER (finite)
00237   BOOL_MAPPER (fix)
00238   BOOL_MAPPER (floor)
00239   BOOL_MAPPER (gamma)
00240   BOOL_MAPPER (imag)
00241   BOOL_MAPPER (isinf)
00242   BOOL_MAPPER (isna)
00243   BOOL_MAPPER (isnan)
00244   BOOL_MAPPER (lgamma)
00245   BOOL_MAPPER (log)
00246   BOOL_MAPPER (log2)
00247   BOOL_MAPPER (log10)
00248   BOOL_MAPPER (log1p)
00249   BOOL_MAPPER (real)
00250   BOOL_MAPPER (round)
00251   BOOL_MAPPER (roundb)
00252   BOOL_MAPPER (signum)
00253   BOOL_MAPPER (sin)
00254   BOOL_MAPPER (sinh)
00255   BOOL_MAPPER (sqrt)
00256   BOOL_MAPPER (tan)
00257   BOOL_MAPPER (tanh)
00258 
00259 #undef BOOL_MAPPER
00260 
00261 private:
00262 
00263   DECLARE_OCTAVE_ALLOCATOR
00264 
00265   DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
00266 };
00267 
00268 #endif
00269 
00270 /*
00271 ;;; Local Variables: ***
00272 ;;; mode: C++ ***
00273 ;;; End: ***
00274 */
	Octave-Forge - Extra packages for GNU Octave
	Home · Packages · Developers · Documentation · FAQ · Bugs · Mailing Lists · Links · Code
Navigation

ov-bool.h
