sbdict(3) [debian man page]
SbDict(3) Coin SbDict(3) NAME
SbDict - The SbDict class organizes a dictionary of keys and values. It uses hashing to quickly insert and find entries in the dictionary. An entry consists of an unique key and a generic pointer. SYNOPSIS
#include <Inventor/SbDict.h> Public Types typedef uintptr_t Key Public Member Functions SbDict (const int entries=251) SbDict (const SbDict &from) ~SbDict () SbDict & operator= (const SbDict &from) void applyToAll (SbDictApplyFunc *rtn) const void applyToAll (SbDictApplyDataFunc *rtn, void *data) const void clear (void) SbBool enter (const Key key, void *const value) SbBool find (const Key key, void *&value) const void makePList (SbPList &keys, SbPList &values) SbBool remove (const Key key) void setHashingFunction (SbDictHashingFunc *func) Detailed Description The SbDict class organizes a dictionary of keys and values. It uses hashing to quickly insert and find entries in the dictionary. An entry consists of an unique key and a generic pointer. Constructor &; Destructor Documentation SbDict::SbDict (const intentries = 251) Constructor with entries specifying the initial number of buckets in the hash list -- so it need to be larger than 0. Other than this, no special care needs to be taken in choosing the value since it is always rounded up to the nearest power of two. SbDict::SbDict (const SbDict &from) Copy constructor. SbDict::~SbDict () Destructor. Member Function Documentation SbDict & SbDict::operator= (const SbDict &from) Make a shallow copy of the contents of dictionary from into this dictionary. void SbDict::applyToAll (SbDictApplyFunc *rtn) const Applies rtn to all entries in the dictionary. void SbDict::applyToAll (SbDictApplyDataFunc *rtn, void *data) const This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. void SbDict::clear (void) Clear all entries in the dictionary. SbBool SbDict::enter (const Keykey, void *constvalue) Inserts a new entry into the dictionary. key should be a unique number, and value is the generic user data. If key does not exist in the dictionary, a new entry is created and TRUE is returned. Otherwise, the generic user data is changed to value, and FALSE is returned. SbBool SbDict::find (const Keykey, void *&value) const Searches for key in the dictionary. If an entry with this key exists, TRUE is returned and the entry value is returned in value. Otherwise, FALSE is returned. void SbDict::makePList (SbPList &keys, SbPList &values) Creates lists with all entries in the dictionary. SbBool SbDict::remove (const Keykey) Removes the entry with key key. TRUE is returned if an entry with this key was present, FALSE otherwise. void SbDict::setHashingFunction (SbDictHashingFunc *func) Sets a new hashing function for this dictionary. Default hashing function just returns the key. If you find that items entered into the dictionary seems to make clusters in only a few buckets, you should try setting a hashing function. If you're for instance using strings, you could use the static SbString::hash() function (you'd need to make a static function that will cast from SbDict::Key to char * of course). This function is not part of the OIV API. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SbDict(3)
Check Out this Related Man Page
SbName(3) Coin SbName(3) NAME
SbName - The SbName class stores strings by reference. The class is used by Coin for storing keywords, names and other strings. They are stored in a manner where identical strings are guaranteed to map to the same memory address (as returned by the SbName::getString() method). SYNOPSIS
#include <Inventor/SbName.h> Public Member Functions SbName (void) SbName (const char *namestring) SbName (const SbString &str) SbName (const SbName &name) ~SbName () const char * getString (void) const int getLength (void) const int operator! (void) const operator const char * (void) const Static Public Member Functions static SbBool isIdentStartChar (const char c) static SbBool isIdentChar (const char c) static SbBool isBaseNameStartChar (const char c) static SbBool isBaseNameChar (const char c) static const SbName & empty (void) Friends int operator== (const SbName &lhs, const char *rhs) int operator== (const char *lhs, const SbName &rhs) int operator== (const SbName &lhs, const SbName &rhs) int operator!= (const SbName &lhs, const char *rhs) int operator!= (const char *lhs, const SbName &rhs) int operator!= (const SbName &lhs, const SbName &rhs) Detailed Description The SbName class stores strings by reference. The class is used by Coin for storing keywords, names and other strings. They are stored in a manner where identical strings are guaranteed to map to the same memory address (as returned by the SbName::getString() method). The main advantage of storing identical strings to the same memory address is that it simplifies comparison operations, and particularly when working with string data as keys in other data structures, like e.g. in hash (dictionary) tables. Apart from that, mapping identical strings to the same memory address can also save on memory resources, and provide run-time optimizations. String comparisons for SbName objects are very efficient, for instance. There is an aspect of using SbName instances that it is important to be aware of: since strings are stored permanently, using SbName instances in code where there is continually changing strings or the continual addition of new unique strings will in the end swamp memory resources. So where possible, use SbString instances instead. See also: SbString Constructor &; Destructor Documentation SbName::SbName (void) This is the default constructor. SbName::SbName (const char *namestring) Constructor. Adds the namestring string to the name table. SbName::SbName (const SbString &str) Constructor. Adds str to the name table. SbName::SbName (const SbName &name) Copy constructor. SbName::~SbName () The destructor. Member Function Documentation const char * SbName::getString (void) const This method returns pointer to character array for the name. The returned memory pointer for the character string is guaranteed to be valid for the remaining life time of the process, even after all SbName instances referencing the string has been destructed. int SbName::getLength (void) const This method returns the number of characters in the name. int SbName::operator! (void) const This unary operator results in FALSE if the SbName object is non-empty and TRUE if the SbName object is empty. An empty name contains a null-length string. SbName::operator const char * (void) const This operator returns a pointer to the character array for the name string. It is intended for implicit use. Use SbName::getString() explicitly instead of this operator - it might be removed later. See also: const char * SbName::getString(void) SbBool SbName::isIdentStartChar (const charc) [static] This method checks if the c character is a valid identifier start character for a name. See also: SbBool SbName::isIdentChar(const char c) SbBool SbName::isIdentChar (const charc) [static] This method checks if the c character is a valid character for a name. See also: SbBool SbName::isIdentStartChar(const char c) SbBool SbName::isBaseNameStartChar (const charc) [static] Returns TRUE if the given character is valid for use as the first character of a name for an object derived from a class inheriting SoBase. SoBase derived objects needs to be named in a manner which will not clash with the special characters reserved as tokens in the syntax rules of Open Inventor and VRML files. Legal characters for the first character of an SoBase object name is underscore ('_') and any uppercase and lowercase alphabetic character from the ASCII character set (i.e. A-Z and a-z). This method is not part of the original Open Inventor API. See also: isBaseNameChar() SbBool SbName::isBaseNameChar (const charc) [static] Returns TRUE if the given character is valid for use in naming object instances of classes derived from SoBase. SoBase derived objects needs to be named in a manner which will not clash with the special characters reserved as tokens in the syntax rules of Open Inventor and VRML files. Legal characters to use for an SoBase object name is any character from the ASCII character set from and including character 33 (hex 0x21) to and including 126 (hex 0x7e), except single and double apostrophes, the plus sign and punctuation, backslash and the curly braces. This method is not part of the original Open Inventor API. See also: isBaseNameStartChar() const SbName & SbName::empty (void) [static] Returns an empty-string SbName instance. Since: Coin 3.0 Friends And Related Function Documentation int operator== (const SbName &lhs, const char *rhs) [friend] This operator checks for equality and returns TRUE if so, and FALSE otherwise. int operator== (const char *lhs, const SbName &rhs) [friend] This operator checks for equality and returns TRUE if so, and FALSE otherwise. int operator== (const SbName &lhs, const SbName &rhs) [friend] This operator checks for equality and returns TRUE if so, and FALSE otherwise. int operator!= (const SbName &lhs, const char *rhs) [friend] This operator checks for inequality and returns TRUE if so, and FALSE if the names are equal. int operator!= (const char *lhs, const SbName &rhs) [friend] This operator checks for inequality and returns TRUE if so, and FALSE if the names are equal. int operator!= (const SbName &lhs, const SbName &rhs) [friend] This operator checks for inequality and returns TRUE if so, and FALSE if the names are equal. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SbName(3)