Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 2.89 KB

struct_CodeGenerator_FunctionTemplate.rst

File metadata and controls

85 lines (53 loc) · 2.89 KB
Raw
.. index:: pair: struct; CodeGenerator::FunctionTemplate

struct CodeGenerator::FunctionTemplate

.. toctree::
        :hidden:

Overview

Immutable structure for specifying how to implement a generic function e.g. :ref:`More...<details-dc/df1/structCodeGenerator_1_1FunctionTemplate>`

.. ref-code-block:: cpp
        :class: doxyrest-overview-code-block

        #include <codeGenUtils.h>

        struct FunctionTemplate
        {
                // fields

                const std::string :ref:`genericName<doxid-dc/df1/structCodeGenerator_1_1FunctionTemplate_1a6dadccba6701a1236789870f40ddbf8d>`;
                const unsigned int :ref:`numArguments<doxid-dc/df1/structCodeGenerator_1_1FunctionTemplate_1acbaeb772934eb40f024283602624d0f1>`;
                const std::string :ref:`doublePrecisionTemplate<doxid-dc/df1/structCodeGenerator_1_1FunctionTemplate_1ab67a3eae53a7343c1e3b2ce33b9140b4>`;
                const std::string :ref:`singlePrecisionTemplate<doxid-dc/df1/structCodeGenerator_1_1FunctionTemplate_1a01e8c32ad3139cf75813c0972f61eaa9>`;

                // methods

                FunctionTemplate :target:`operator =<doxid-dc/df1/structCodeGenerator_1_1FunctionTemplate_1a1c3e3ea299ad5f722805b32af07275a4>` (const FunctionTemplate& o);
        };

Detailed Documentation

Immutable structure for specifying how to implement a generic function e.g. gennrand_uniform

NOTE for the sake of easy initialisation first two parameters of GenericFunction are repeated (C++17 fixes)

Fields

.. index:: pair: variable; genericName

.. ref-code-block:: cpp
        :class: doxyrest-title-code-block

        const std::string genericName

Generic name used to refer to function in user code.

.. index:: pair: variable; numArguments

.. ref-code-block:: cpp
        :class: doxyrest-title-code-block

        const unsigned int numArguments

Number of function arguments.

.. index:: pair: variable; doublePrecisionTemplate

.. ref-code-block:: cpp
        :class: doxyrest-title-code-block

        const std::string doublePrecisionTemplate

The function template (for use with :ref:`functionSubstitute <doxid-d0/d02/namespaceCodeGenerator_1a7308be23a7721f3913894290bcdd7831>`) used when model uses double precision.

.. index:: pair: variable; singlePrecisionTemplate

.. ref-code-block:: cpp
        :class: doxyrest-title-code-block

        const std::string singlePrecisionTemplate

The function template (for use with :ref:`functionSubstitute <doxid-d0/d02/namespaceCodeGenerator_1a7308be23a7721f3913894290bcdd7831>`) used when model uses single precision.