GNU Octave 10.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 
Loading...
Searching...
No Matches
Classes | Macros | Enumerations | Functions | Variables
ov-base.h File Reference
#include "octave-config.h"
#include <cstdlib>
#include <iosfwd>
#include <list>
#include <memory>
#include <string>
#include "Range.h"
#include "data-conv.h"
#include "mx-base.h"
#include "str-vec.h"
#include "auto-shlib.h"
#include "oct-hdf5-types.h"
#include "oct-stream.h"

Go to the source code of this file.

Classes

struct  btyp_to_class< BTYP >
 
struct  btyp_to_class< btyp_bool >
 
struct  btyp_to_class< btyp_char >
 
struct  btyp_to_class< btyp_complex >
 
struct  btyp_to_class< btyp_double >
 
struct  btyp_to_class< btyp_float >
 
struct  btyp_to_class< btyp_float_complex >
 
struct  btyp_to_class< btyp_int16 >
 
struct  btyp_to_class< btyp_int32 >
 
struct  btyp_to_class< btyp_int64 >
 
struct  btyp_to_class< btyp_int8 >
 
struct  btyp_to_class< btyp_uint16 >
 
struct  btyp_to_class< btyp_uint32 >
 
struct  btyp_to_class< btyp_uint64 >
 
struct  btyp_to_class< btyp_uint8 >
 
struct  class_to_btyp< T >
 
struct  class_to_btyp< bool >
 
struct  class_to_btyp< char >
 
struct  class_to_btyp< Complex >
 
struct  class_to_btyp< double >
 
struct  class_to_btyp< float >
 
struct  class_to_btyp< FloatComplex >
 
struct  class_to_btyp< octave_int16 >
 
struct  class_to_btyp< octave_int32 >
 
struct  class_to_btyp< octave_int64 >
 
struct  class_to_btyp< octave_int8 >
 
struct  class_to_btyp< octave_uint16 >
 
struct  class_to_btyp< octave_uint32 >
 
struct  class_to_btyp< octave_uint64 >
 
struct  class_to_btyp< octave_uint8 >
 
class  octave_base_dld_value
 
class  octave_base_value
 
class  octave_base_value::type_conv_info
 

Macros

#define DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA    DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (virtual, OCTAVE_EMPTY_CPP_ARG)
 
#define DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA_API(API)    DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (virtual, API)
 
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
 
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2(VIRTUAL, API)
 
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA_API(API)    DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (OCTAVE_EMPTY_CPP_ARG, API)
 
#define DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS(cls, type)
 
#define DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS_API(cls, type, API)
 
#define DEF_BTYP_TRAITS(BTYP, CLASS)
 
#define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA(t, n, c)    DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL ( , t, n, c)
 
#define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL(tspec, t, n, c)
 
#define DEFINE_TEMPLATE_OV_TYPEID_FUNCTIONS_AND_DATA(t, n, c)    DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL (template <>, t, n, c)
 
#define OCTAVE_EMPTY_CPP_ARG   /* empty */
 

Enumerations

enum  builtin_type_t {
  btyp_double , btyp_float , btyp_complex , btyp_float_complex ,
  btyp_int8 , btyp_int16 , btyp_int32 , btyp_int64 ,
  btyp_uint8 , btyp_uint16 , btyp_uint32 , btyp_uint64 ,
  btyp_bool , btyp_char , btyp_struct , btyp_cell ,
  btyp_func_handle , btyp_unknown , btyp_num_types = btyp_unknown
}
 

Functions

type_info & __get_type_info__ ()
 
type_info & __get_type_info__ (const std::string &)
 
bool btyp_isarray (builtin_type_t btyp)
 
bool btyp_isfloat (builtin_type_t btyp)
 
bool btyp_isinteger (builtin_type_t btyp)
 
bool btyp_isnumeric (builtin_type_t btyp)
 
builtin_type_t btyp_mixed_numeric (builtin_type_t x, builtin_type_t y)
 Determine the resulting type for a possible mixed-type operation.
 
bool called_from_builtin ()
 
octave_value make_idx_args (const std::string &type, const std::list< octave_value_list > &idx, const std::string &who)
 

Variables

std::string btyp_class_name []
 

Macro Definition Documentation

◆ DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA

#define DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA    DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (virtual, OCTAVE_EMPTY_CPP_ARG)

Definition at line 188 of file ov-base.h.

◆ DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA_API

#define DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA_API (   API)     DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (virtual, API)

Definition at line 191 of file ov-base.h.

◆ DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA

#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
Value:
DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (OCTAVE_EMPTY_CPP_ARG, \
OCTAVE_EMPTY_CPP_ARG)
DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2(VIRTUAL, API)
Definition ov-base.h:194
OCTAVE_EMPTY_CPP_ARG
#define OCTAVE_EMPTY_CPP_ARG
Definition ov-base.h:179

Definition at line 181 of file ov-base.h.

◆ DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2

#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (   VIRTUAL,
  API 
)
Value:
public: \
VIRTUAL int type_id () const { return s_t_id; } \
VIRTUAL std::string type_name () const { return s_t_name; } \
VIRTUAL std::string class_name () const { return s_c_name; } \
static int static_type_id () { return s_t_id; } \
static std::string static_type_name () { return s_t_name; } \
static std::string static_class_name () { return s_c_name; } \
API static void register_type (); \
API static void register_type (octave::type_info&); \
\
private: \
static API int s_t_id; \
static API const std::string s_t_name; \
static API const std::string s_c_name;
register_type
int register_type(const std::string &t_name, const std::string &c_name, const octave_value &val)
Definition ov-typeinfo.cc:784

Definition at line 194 of file ov-base.h.

◆ DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA_API

#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA_API (   API)     DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (OCTAVE_EMPTY_CPP_ARG, API)

Definition at line 185 of file ov-base.h.

◆ DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS

#define DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS (   cls,
  type 
)
Value:
DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS_API (cls, type, \
OCTAVE_EMPTY_CPP_ARG)
DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS_API
#define DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS_API(cls, type, API)
Definition ov-base.h:214

Definition at line 210 of file ov-base.h.

◆ DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS_API

#define DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS_API (   cls,
  type,
  API 
)
Value:
template <> API void cls<type>::register_type (); \
template <> API void cls<type>::register_type (octave::type_info&); \
template <> API int cls<type>::s_t_id; \
template <> API const std::string cls<type>::s_t_name; \
template <> API const std::string cls<type>::s_c_name;

Definition at line 214 of file ov-base.h.

◆ DEF_BTYP_TRAITS

#define DEF_BTYP_TRAITS (   BTYP,
  CLASS 
)
Value:
template <> \
struct class_to_btyp<CLASS> \
{ \
static const builtin_type_t btyp = BTYP; \
}; \
\
template <> \
struct btyp_to_class<BTYP> \
{ \
typedef CLASS type; \
}
builtin_type_t
builtin_type_t
Definition ov-base.h:83
btyp_to_class
Definition ov-base.h:143
btyp_to_class::type
void type
Definition ov-base.h:144
class_to_btyp
Definition ov-base.h:137
class_to_btyp::btyp
static const builtin_type_t btyp
Definition ov-base.h:138

Definition at line 147 of file ov-base.h.

◆ DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA

#define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (   t,
  n,
  c 
)     DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL ( , t, n, c)

Definition at line 246 of file ov-base.h.

◆ DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL

#define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL (   tspec,
  t,
  n,
  c 
)
Value:
tspec int t::s_t_id (-1); \
tspec const std::string t::s_t_name (n); \
tspec const std::string t::s_c_name (c); \
tspec void t::register_type () \
{ \
octave::type_info& type_info = octave::__get_type_info__ (); \
\
register_type (type_info); \
} \
tspec void t::register_type (octave::type_info& ti) \
{ \
octave_value v = (new t ()); \
s_t_id = ti.register_type (t::s_t_name, t::s_c_name, v); \
}
octave_value
Definition ov.h:75
type_info
Definition ov-typeinfo.h:43

Definition at line 227 of file ov-base.h.

◆ DEFINE_TEMPLATE_OV_TYPEID_FUNCTIONS_AND_DATA

#define DEFINE_TEMPLATE_OV_TYPEID_FUNCTIONS_AND_DATA (   t,
  n,
  c 
)     DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL (template <>, t, n, c)

Definition at line 243 of file ov-base.h.

◆ OCTAVE_EMPTY_CPP_ARG

#define OCTAVE_EMPTY_CPP_ARG   /* empty */

Definition at line 179 of file ov-base.h.

Enumeration Type Documentation

◆ builtin_type_t

enum builtin_type_t
Enumerator
btyp_double 
btyp_float 
btyp_complex 
btyp_float_complex 
btyp_int8 
btyp_int16 
btyp_int32 
btyp_int64 
btyp_uint8 
btyp_uint16 
btyp_uint32 
btyp_uint64 
btyp_bool 
btyp_char 
btyp_struct 
btyp_cell 
btyp_func_handle 
btyp_unknown 
btyp_num_types 

Definition at line 82 of file ov-base.h.

Function Documentation

◆ __get_type_info__() [1/2]

type_info & __get_type_info__ ( )
extern

Definition at line 140 of file interpreter-private.cc.

References __get_interpreter__(), and interpreter::get_type_info().

Referenced by __get_type_info__().

◆ __get_type_info__() [2/2]

type_info & __get_type_info__ ( const std::string &  )
inline

Definition at line 63 of file ov-base.h.

References __get_type_info__().

◆ btyp_isarray()

bool btyp_isarray ( builtin_type_t  btyp)
inline

Definition at line 116 of file ov-base.h.

◆ btyp_isfloat()

bool btyp_isfloat ( builtin_type_t  btyp)
inline

Definition at line 113 of file ov-base.h.

References btyp_float_complex.

Referenced by ov_range< T >::isfloat().

◆ btyp_isinteger()

bool btyp_isinteger ( builtin_type_t  btyp)
inline

Definition at line 110 of file ov-base.h.

References btyp_int8, and btyp_uint64.

Referenced by ov_range< T >::isinteger().

◆ btyp_isnumeric()

bool btyp_isnumeric ( builtin_type_t  btyp)
inline

Definition at line 107 of file ov-base.h.

References btyp_uint64.

Referenced by ov_range< T >::isnumeric().

◆ btyp_mixed_numeric()

builtin_type_t btyp_mixed_numeric ( builtin_type_t  x,
builtin_type_t  y 
)
extern

Determine the resulting type for a possible mixed-type operation.

Rules for the resulting type:

  • bool -> double
  • single + double -> single
  • real + complex -> complex
  • integer + real -> integer
  • uint + uint -> uint (the bigger one)
  • sint + sint -> sint (the bigger one)
Returns
The resulting type or "unknown type", if the resulting type cannot be determined.

Definition at line 67 of file ov-base.cc.

References btyp_bool, btyp_double, btyp_unknown, and x.

◆ called_from_builtin()

bool called_from_builtin ( )
extern

Definition at line 1513 of file ov-base.cc.

References octave_function::name().

Referenced by octave_class::size(), octave_classdef::size(), octave_classdef::subsasgn(), octave_class::subsref(), octave_classdef::subsref(), octave_class::xnumel(), and octave_classdef::xnumel().

◆ make_idx_args()

octave_value make_idx_args ( const std::string &  type,
const std::list< octave_value_list > &  idx,
const std::string &  who 
)
extern

Definition at line 1450 of file ov-base.cc.

References octave_map::assign(), error(), octave_value::is_string(), len, octave_value::length(), and octave_value_list::length().

Referenced by octave_classdef::subsasgn(), octave_classdef::subsref(), octave_class::subsref(), and octave_classdef::subsref().

Variable Documentation

◆ btyp_class_name

std::string btyp_class_name[]
extern

Definition at line 91 of file ov-base.cc.

Referenced by Fmod(), Frem(), and get_dispatch_type().