GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
octave_scalar_map Class Reference

#include "oct-map.h"

Public Types

typedef octave_fields::const_iterator const_iterator
 
typedef const_iterator iterator
 

Public Member Functions

 octave_scalar_map (const octave_fields &k)
 
 octave_scalar_map (const std::map< std::string, octave_value > &m)
 
 octave_scalar_map (const string_vector &k)
 
void assign (const std::string &k, const octave_value &val)
 
const_iterator begin () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
void clear ()
 
bool contains (const std::string &name) const
 
octave_valuecontents (const std::string &k)
 
octave_value contents (const std::string &k) const
 
const octave_valuecontents (const_iterator p) const
 
octave_valuecontents (iterator p)
 
octave_valuecontents (octave_idx_type i)
 
const octave_valuecontents (octave_idx_type i) const
 
void del (const std::string &k)
 
const_iterator end () const
 
string_vector fieldnames () const
 
octave_value getfield (const std::string &key) const
 
octave_idx_type index (const_iterator p) const
 
bool isfield (const std::string &name) const
 
std::string key (const_iterator p) const
 
string_vector keys () const
 
octave_idx_type nfields () const
 
octave_scalar_map orderfields () const
 
octave_scalar_map orderfields (Array< octave_idx_type > &perm) const
 
octave_scalar_map orderfields (const octave_scalar_map &other, Array< octave_idx_type > &perm) const
 
void rmfield (const std::string &key)
 
const_iterator seek (const std::string &k) const
 
void setfield (const std::string &key, const octave_value &val)
 

Friends

class octave_map
 

Detailed Description

Definition at line 163 of file oct-map.h.

Member Typedef Documentation

◆ const_iterator

◆ iterator

Definition at line 182 of file oct-map.h.

Constructor & Destructor Documentation

◆ octave_scalar_map() [1/3]

octave_scalar_map::octave_scalar_map ( const octave_fields k)
inline

Definition at line 168 of file oct-map.h.

◆ octave_scalar_map() [2/3]

octave_scalar_map::octave_scalar_map ( const string_vector k)
inline

Definition at line 171 of file oct-map.h.

◆ octave_scalar_map() [3/3]

octave_scalar_map::octave_scalar_map ( const std::map< std::string, octave_value > &  m)

Definition at line 169 of file oct-map.cc.

References octave_fields::getfield(), and m.

Member Function Documentation

◆ assign()

void octave_scalar_map::assign ( const std::string &  k,
const octave_value val 
)
inline

◆ begin()

const_iterator octave_scalar_map::begin ( ) const
inline

Definition at line 184 of file oct-map.h.

References octave_fields::begin().

◆ cbegin()

const_iterator octave_scalar_map::cbegin ( ) const
inline

Definition at line 187 of file oct-map.h.

Referenced by octave_scalar_struct::byte_size().

◆ cend()

const_iterator octave_scalar_map::cend ( ) const
inline

Definition at line 188 of file oct-map.h.

Referenced by octave_scalar_struct::byte_size().

◆ clear()

void octave_scalar_map::clear ( )
inline

Definition at line 247 of file oct-map.h.

◆ contains()

bool octave_scalar_map::contains ( const std::string &  name) const
inline

Definition at line 216 of file oct-map.h.

Referenced by Frethrow().

◆ contents() [1/6]

octave_value & octave_scalar_map::contents ( const std::string &  k)

Definition at line 254 of file oct-map.cc.

References octave_fields::getfield().

◆ contents() [2/6]

octave_value octave_scalar_map::contents ( const std::string &  k) const

Definition at line 248 of file oct-map.cc.

References getfield().

◆ contents() [3/6]

◆ contents() [4/6]

octave_value& octave_scalar_map::contents ( iterator  p)
inline

Definition at line 200 of file oct-map.h.

◆ contents() [5/6]

octave_value& octave_scalar_map::contents ( octave_idx_type  i)
inline

Definition at line 206 of file oct-map.h.

◆ contents() [6/6]

const octave_value& octave_scalar_map::contents ( octave_idx_type  i) const
inline

Definition at line 203 of file oct-map.h.

◆ del()

void octave_scalar_map::del ( const std::string &  k)
inline

Definition at line 235 of file oct-map.h.

◆ end()

const_iterator octave_scalar_map::end ( ) const
inline

Definition at line 185 of file oct-map.h.

◆ fieldnames()

string_vector octave_scalar_map::fieldnames ( ) const
inline

Definition at line 219 of file oct-map.h.

◆ getfield()

octave_value octave_scalar_map::getfield ( const std::string &  key) const

Definition at line 183 of file oct-map.cc.

References octave_fields::getfield(), and octave_value().

Referenced by contents(), Famd(), and figure::properties::set___mouse_mode__().

◆ index()

octave_idx_type octave_scalar_map::index ( const_iterator  p) const
inline

Definition at line 194 of file oct-map.h.

◆ isfield()

bool octave_scalar_map::isfield ( const std::string &  name) const
inline

Definition at line 213 of file oct-map.h.

◆ key()

std::string octave_scalar_map::key ( const_iterator  p) const
inline

Definition at line 192 of file oct-map.h.

Referenced by octave_scalar_struct::byte_size().

◆ keys()

string_vector octave_scalar_map::keys ( ) const
inline

Definition at line 222 of file oct-map.h.

◆ nfields()

octave_idx_type octave_scalar_map::nfields ( ) const
inline

◆ orderfields() [1/3]

octave_scalar_map octave_scalar_map::orderfields ( ) const

Definition at line 208 of file oct-map.cc.

Referenced by permute_to_correct_order1().

◆ orderfields() [2/3]

octave_scalar_map octave_scalar_map::orderfields ( Array< octave_idx_type > &  perm) const

Definition at line 215 of file oct-map.cc.

References nfields(), octave_fields::orderfields(), and Array< T, Alloc >::xelem().

◆ orderfields() [3/3]

octave_scalar_map octave_scalar_map::orderfields ( const octave_scalar_map other,
Array< octave_idx_type > &  perm 
) const

◆ rmfield()

void octave_scalar_map::rmfield ( const std::string &  key)

Definition at line 200 of file oct-map.cc.

References octave_fields::rmfield().

◆ seek()

const_iterator octave_scalar_map::seek ( const std::string &  k) const
inline

Definition at line 190 of file oct-map.h.

◆ setfield()

Friends And Related Function Documentation

◆ octave_map

friend class octave_map
friend

Definition at line 253 of file oct-map.h.


The documentation for this class was generated from the following files: