Dictionary.m

Go to the documentation of this file.

/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

class Dictionary
  :public handle {
    private:

        List;
    public: /* ( Dependent ) */

        cell Keys;
        cell Values;
        integer Count;
    public: /* ( Dependent ) */

        Dictionary() {
            this.List= struct(" Key ",[]," Value ",[]);
        }
        function  set(char key,any value) {
            this.set_(key, value);
        }
        function value = get(char key) {
            value = this.get_(key);
        }
        function  clear(key) {
            if nargin ==  2
                cidx = [];
                for i=1:length(this.List)
                    if strcmp(this.List(i).Key,key)
                        cidx = i;
                    end
                end
                if ~isempty(cidx)
                    this.List(cidx) = [];
                end
            else
                this.List= struct(" Key ",[]," Value ",[]);
            end
        }
        function bool = containsKey(char key) {
            if ~isa(key," char ")
                error(" Key must be a string. ");
            end
            bool = false;
            for i=1:length(this.List)
                if strcmp(this.List(i).Key,key)
                    bool = true;
                    return;
                end
            end
        }
        function varargout = subsref(key) {
            if (isequal(key(1).type," () "))
                varargout[1] = this.get_(key(1).subs[1]);
                if length(key) > 1
                    [varargout[1:nargout]] = builtin(" subsref ", varargout, key(2:end));
                end
            else
                [varargout[1:nargout]] = builtin(" subsref ", this, key);
            end
        }
        function this = subsasgn(key,value) {
            if (isequal(key(1).type," () "))
                if length(key) > 1
                    value = builtin(" subsasgn ", this.get_(key(1).subs[1]), key(2:end), value);
                end
                this.set_(key(1).subs[1], value);
            else
                builtin(" subsasgn ", this, key, value);
            end
        }
#if 0 //mtoc++: 'get.Count'
function c = Count() {
            c = length(this.List);
        }

#endif


        
#if 0 //mtoc++: 'get.Keys'
function k = Keys() {
            k = [this.List(:).Key];
        }

#endif


        
#if 0 //mtoc++: 'get.Values'
function k = Values() {
            k = [this.List(:).Value];
        }

#endif


        function  display() {
            fprintf(" Dictionary with %d elements.\n ",this.Count);
            arrayfun(@(kv)(disp([" Key: " kv.Key " Value: " kv.Value])),this.List);
        }
    private: /* ( Dependent ) */

        function value = get_(key) {
            value = [];
            if isempty(key)
                return;    
            end
            if isa(key, " char ")
                for i=1:length(this.List)
                    if isequal(this.List(i).Key,key)
                        /*  Return found value */
                        value = this.List(i).Value;
                        break;
                    end
                end
                return;
            elseif isposintscalar(key)
                if key < 1 || key > this.Count
                    error(" Key index exceeds dictionary. ");
                end
                value = this.List(key).Value;
                return;
            end
            error(" The key must be a string or integer ");
        }
        function  set_(key,value) {
            if isa(key, " char ")
                for i=1:length(this.List)
                    if isequal(this.List(i).Key,key)
                        /*  Set value if already in list */
                        this.List(i).Value = value;
                        return;
                    end
                end
                /*  Otherwise: Extend! */
                this.List(end+1).Key = key;
                this.List(end).Value = value;
            elseif isposintscalar(key)
                if key < 1 || key > this.Count
                    error(" Setting per numerical index only allowed within existing items; use a char key for automatic insertions. ");
                end
                this.List(key).Value = value;
                return;
            end   
        }
};