IClassConfig.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 IClassConfig
  :public KerMorObject,
   public ICloneable {
    public:

        ICloneable Prototype;
    protected:

        char RequiredPrototypeClass = "[]";
    public: /* ( Sealed ) */

        function lbl = getAxisLabels(nrs) {
            if nargin < 2
                nrs = 1:this.getNumConfigurations;
            end
            lbl = arrayfun(@convert,nrs," Unif ",false);

            function o = convert(e)
                tmp = this.getConfigurationString(e, true);
                o = Utils.implode(tmp,sprintf(" / "));
            end
        }


        function doublet = getValueRanges() {
            t = PrintTable;
            t.HasHeader= true;
            t.HasRowHeader= true;
            t.addRow(" Location "," Min "," Max ");
            this.collectRanges(t,[this.getClassName]);
        }

    
    public:

        
#if 0 //mtoc++: 'set.Prototype'
function  Prototype(value) {
            if ~isa(value, " ICloneable ")
                error(" The prototype must be a ICloneable descendant. ");
            elseif ~isempty(this.RequiredPrototypeClass) && ...
                    ~isa(value,this.RequiredPrototypeClass)/* #ok */

                error(" The prototype must be a %s descendant. ",...
                    this.RequiredPrototypeClass);/* #ok */

            end
            this.Prototype= value;
        }

#endif


        function copy = clone(copy) {
            if nargin < 2
                error(" You must call this clone method passing a cloned subclass instance. ");
            end
            /*  Dont clone the prototype here; it's cloned anyways every time
             * a new instance is configured. */
            copy.Prototype= this.Prototype;
            copy.RequiredPrototypeClass= this.RequiredPrototypeClass;
        }

    
    protected:

        function ptype = getProtoClass() {
            if isempty(this.Prototype)
                error(" No prototype set ");
            end
            ptype = this.Prototype.clone();
        }


        function idx = getPartIndices(partNr,totalParts) {
            rs = RangeSplitter(this.getNumConfigurations, " Num ", totalParts);
            idx = rs.getPart(partNr);
        }


        function  addRange(ptable,proppath,minval,maxval) {
            head = Utils.implode(proppath," . ");
            ptable.addRow(head,minval,maxval);
        }

    
    public: /* ( Abstract ) */

        virtual function integern = getNumConfigurations() = 0;
        virtual function ICloneableobject = configureInstance(integer nr) = 0;
        virtual function integerstr = getConfigurationString(integer nr,logical asCell) = 0;
        virtual function charstr = getConfiguredPropertiesString() = 0;
        virtual function IClassConfigconf = getSubPart(integer partNr,integer totalParts) = 0;
    protected: /* ( Abstract ) */

        virtual function  collectRanges(ptable,proppath) = 0;

    
    protected:

        function obj = loadobj(from) {
            if nargin < 2 || ~isa(from," IClassConfig ")
                error(" Must call this loadobj method from subclass with subclass instance ");
            end
            obj = loadobj@KerMorObject(obj, from);
            obj.Prototype= from.Prototype;
            obj.RequiredPrototypeClass= from.RequiredPrototypeClass;
        }

    
    public: /* ( Static ) */

        static function  test_ClassConfigPlots() {
            
            pm = PlotManager(false,2,2);
            pm.LeaveOpen= true;
            runTest(kernels.config.RBFConfig(" G ",.4:.01:.6));
            runTest(kernels.config.GaussConfig(" G ",1:10));
            runTest(kernels.config.WendlandConfig(" G ",1:5," S ",(1:5)/2," D ",2));

            pm.done;

            function runTest(c)
                fprintf(" %s: %s ",c.getClassName,c.getConfiguredPropertiesString);
                nc = c.getNumConfigurations;
                x = 1:nc;
                fx = ones(size(x));
                h = pm.nextPlot(c.getClassName,c.getClassName);
                plot(h,x,fx);
                set(h," XTick ",1:nc," XTickLabel ",c.getAxisLabels);
                disp(c.getAxisLabels);
            end            
        }

    
};