LinearCoreFun.m

Go to the documentation of this file.

namespace dscomponents{


/* (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 LinearCoreFun
  :public dscomponents.ACoreFun {
    public:

        A;
    public:

        LinearCoreFun(A) {
            this = this@dscomponents.ACoreFun([]);
            if nargin > 0
                this.A= A;
                /*  If not set here, subclasses must take care to set xDim
                 * whenever A changes. */
                this.fDim= size(A,1);
                this.xDim= size(A,2);
                /*  Compute sparsity pattern */
                if issparse(A)
                    this.JSparsityPattern= A ~= 0;
                end
            end
            this.CustomProjection= true;
            this.TimeDependent= false;
        }
        function projected = project(V,W,projected) {
            if nargin < 4
                projected = this.clone;
            end
            projected.A= W^t*(this.A*V);
        }


        function copy = clone() {
            copy = clone@dscomponents.ACoreFun(this, dscomponents.LinearCoreFun);
            copy.A= this.A;
        }


        function fx = evaluate(colvec<double> x,unused1,unused2) {
            fx = this.A*x;
        }


        function fx = evaluateMulti(colvec<double> x,unused1,unused2) {
            fx = this.A*x;
        }


        function fx = evaluateCoreFun() {
            error(" This method should never be called. ");
        }
        function J = getStateJacobian(unused1,unused2,unused3) {
            J = this.A;
        }


        function prod = mtimes(other) {
            if isa(this," dscomponents.LinearCoreFun ")
                if isa(other," dscomponents.LinearCoreFun ")
                    prod = dscomponents.LinearCoreFun(this.A * other.A);
                else
                    prod = dscomponents.LinearCoreFun(this.A * other);
                end
            elseif isa(other," dscomponents.LinearCoreFun ")
                prod = dscomponents.LinearCoreFun(this * other.A);
            end
        }


        function diff = minus(other) {
            diff = dscomponents.LinearCoreFun(this.A - other.A);
        }


        function diff = plus(other) {
            diff = dscomponents.LinearCoreFun(this.A + other.A);
        }


        function transp = ctranspose() {
            transp = dscomponents.LinearCoreFun(this.A^t);
        }


};
}