Generator: added an external array.

Author: agarny

src/analyser.cpp

@@ -3281,7 +3281,8 @@ void Analyser::AnalyserImpl::analyseModel(const ModelPtr &model)
                                    internalEquation->mNlaSystemIndex,
                                    equationNlaSiblings,
                                    {},
-                                   algebraic);
+                                   algebraic,
+                                   {});
 
         mModel->mPimpl->mEquations.push_back(equation);
     }

src/analyserequation.cpp

@@ -34,7 +34,8 @@ void AnalyserEquation::AnalyserEquationImpl::populate(AnalyserEquation::Type typ
                                                       size_t nlaSystemIndex,
                                                       const std::vector<AnalyserEquationPtr> &nlaSiblings,
                                                       const std::vector<AnalyserVariablePtr> &computedConstants,
-                                                      const std::vector<AnalyserVariablePtr> &algebraic)
+                                                      const std::vector<AnalyserVariablePtr> &algebraic,
+                                                      const std::vector<AnalyserVariablePtr> &externals)
 {
     mType = type;
     mAst = ast;
@@ -44,6 +45,7 @@ void AnalyserEquation::AnalyserEquationImpl::populate(AnalyserEquation::Type typ
     std::copy(nlaSiblings.begin(), nlaSiblings.end(), back_inserter(mNlaSiblings));
     std::copy(computedConstants.begin(), computedConstants.end(), back_inserter(mComputedConstants));
     std::copy(algebraic.begin(), algebraic.end(), back_inserter(mAlgebraic));
+    std::copy(externals.begin(), externals.end(), back_inserter(mExternals));
 }
 
 bool AnalyserEquation::AnalyserEquationImpl::isEmptyDependency(const AnalyserEquationWeakPtr &dependency)
@@ -60,6 +62,12 @@ bool AnalyserEquation::AnalyserEquationImpl::isEmptyDependency(const AnalyserEqu
         return false;
     }
 
+    auto externals = dependency.lock()->externals();
+
+    if (std::any_of(externals.begin(), externals.end(), [](const auto &v) { return v != nullptr; })) {
+        return false;
+    }
+
     return true;
 }
 
@@ -199,4 +207,23 @@ AnalyserVariablePtr AnalyserEquation::algebraic(size_t index) const
     return mPimpl->mAlgebraic[index];
 }
 
+size_t AnalyserEquation::externalCount() const
+{
+    return mPimpl->mExternals.size();
+}
+
+std::vector<AnalyserVariablePtr> AnalyserEquation::externals() const
+{
+    return mPimpl->mExternals;
+}
+
+AnalyserVariablePtr AnalyserEquation::external(size_t index) const
+{
+    if (index >= mPimpl->mExternals.size()) {
+        return {};
+    }
+
+    return mPimpl->mExternals[index];
+}
+
 } // namespace libcellml

src/analyserequation_p.h

@@ -37,6 +37,7 @@ struct AnalyserEquation::AnalyserEquationImpl
     bool mIsStateRateBased = false;
     std::vector<AnalyserVariablePtr> mComputedConstants;
     std::vector<AnalyserVariablePtr> mAlgebraic;
+    std::vector<AnalyserVariablePtr> mExternals;
 
     static AnalyserEquationPtr create();
 
@@ -46,7 +47,8 @@ struct AnalyserEquation::AnalyserEquationImpl
                   size_t nlaSystemIndex,
                   const std::vector<AnalyserEquationPtr> &nlaSiblings,
                   const std::vector<AnalyserVariablePtr> &computedConstants,
-                  const std::vector<AnalyserVariablePtr> &algebraic);
+                  const std::vector<AnalyserVariablePtr> &algebraic,
+                  const std::vector<AnalyserVariablePtr> &externals);
 
     static bool isEmptyDependency(const AnalyserEquationWeakPtr &dependency);
 

src/analysermodel.cpp

@@ -202,6 +202,33 @@ AnalyserVariablePtr AnalyserModel::algebraic(size_t index) const
     return mPimpl->mAlgebraic[index];
 }
 
+size_t AnalyserModel::externalCount() const
+{
+    if (!isValid()) {
+        return 0;
+    }
+
+    return mPimpl->mExternals.size();
+}
+
+std::vector<AnalyserVariablePtr> AnalyserModel::externals() const
+{
+    if (!isValid()) {
+        return {};
+    }
+
+    return mPimpl->mExternals;
+}
+
+AnalyserVariablePtr AnalyserModel::external(size_t index) const
+{
+    if (!isValid() || (index >= mPimpl->mExternals.size())) {
+        return {};
+    }
+
+    return mPimpl->mExternals[index];
+}
+
 size_t AnalyserModel::equationCount() const
 {
     if (!isValid()) {

src/analysermodel_p.h

@@ -38,6 +38,7 @@ struct AnalyserModel::AnalyserModelImpl
     std::vector<AnalyserVariablePtr> mConstants;
     std::vector<AnalyserVariablePtr> mComputedConstants;
     std::vector<AnalyserVariablePtr> mAlgebraic;
+    std::vector<AnalyserVariablePtr> mExternals;
     std::vector<AnalyserEquationPtr> mEquations;
 
     bool mNeedEqFunction = false;

src/api/libcellml/analyserequation.h

@@ -223,6 +223,35 @@ class LIBCELLML_EXPORT AnalyserEquation
      */
     AnalyserVariablePtr algebraic(size_t index) const;
 
+    /**
+     * @brief Get the number of external variables computed by this @ref AnalyserEquation.
+     *
+     * Return the number of external variables computed by this @ref AnalyserEquation.
+     *
+     * @return The number of external variables.
+     */
+    size_t externalCount() const;
+
+    /**
+     * @brief Get the external variables computed by this @ref AnalyserEquation.
+     *
+     * Return the external variables computed by this @ref AnalyserEquation.
+     *
+     * @return The external variables as a @c std::vector.
+     */
+    std::vector<AnalyserVariablePtr> externals() const;
+
+    /**
+     * @brief Get the external variable, at @p index, computed by this @ref AnalyserEquation.
+     *
+     * Return the external variable, at @p index, computed by this @ref AnalyserEquation.
+     *
+     * @param index The index of the external variable to return.
+     *
+     * @return The external variable, at @p index, on success, @c nullptr on failure.
+     */
+    AnalyserVariablePtr external(size_t index) const;
+
 private:
     AnalyserEquation(); /**< Constructor, @private. */
 

src/api/libcellml/analysermodel.h

@@ -231,6 +231,36 @@ class LIBCELLML_EXPORT AnalyserModel
      */
     AnalyserVariablePtr algebraic(size_t index) const;
 
+    /**
+     * @brief Get the number of external variables.
+     *
+     * Return the number of external variables in the @ref AnalyserModel.
+     *
+     * @return The number of external variables.
+     */
+    size_t externalCount() const;
+
+    /**
+     * @brief Get the external variables.
+     *
+     * Return the external variables in the @ref AnalyserModel.
+     *
+     * @return The external variables as a @c std::vector.
+     */
+    std::vector<AnalyserVariablePtr> externals() const;
+
+    /**
+     * @brief Get the external variable at @p index.
+     *
+     * Return the external variable at the index @p index for the @ref AnalyserModel.
+     *
+     * @param index The index of the external variable to return.
+     *
+     * @return The external variable at the given @p index on success, @c nullptr on
+     * failure.
+     */
+    AnalyserVariablePtr external(size_t index) const;
+
     /**
      * @brief Get the number of equations.
      *

src/api/libcellml/generatorprofile.h

@@ -2605,6 +2605,54 @@ class LIBCELLML_EXPORT GeneratorProfile
      */
     void setImplementationAlgebraicCountString(const std::string &implementationAlgebraicCountString);
 
+    /**
+     * @brief Get the @c std::string for the interface of the external count
+     * constant.
+     *
+     * Return the @c std::string for the interface of the external count
+     * constant.
+     *
+     * @return The @c std::string for the interface of the external count
+     * constant.
+     */
+    std::string interfaceExternalCountString() const;
+
+    /**
+     * @brief Set the @c std::string for the interface of the external count
+     * constant.
+     *
+     * Set the @c std::string for the interface of the external count constant.
+     *
+     * @param interfaceExternalCountString The @c std::string to use for the
+     * interface of the external count constant.
+     */
+    void setInterfaceExternalCountString(const std::string &interfaceExternalCountString);
+
+    /**
+     * @brief Get the @c std::string for the implementation of the external
+     * count constant.
+     *
+     * Return the @c std::string for the implementation of the external count
+     * constant.
+     *
+     * @return The @c std::string for the implementation of the external count
+     * constant.
+     */
+    std::string implementationExternalCountString() const;
+
+    /**
+     * @brief Set the @c std::string for the implementation of the external
+     * count constant.
+     *
+     * Set the @c std::string for the implementation of the external count
+     * constant. To be useful, the string should contain the [EXTERNAL_COUNT]
+     * tag, which will be replaced with the number of states in the model.
+     *
+     * @param implementationExternalCountString The @c std::string to use for
+     * the implementation of the external count constant.
+     */
+    void setImplementationExternalCountString(const std::string &implementationExternalCountString);
+
     /**
      * @brief Get the @c std::string for the data structure for the variable
      * type object.

src/bindings/interface/analyserequation.i

@@ -61,6 +61,15 @@
 %feature("docstring") libcellml::AnalyserEquation::algebraic
 "Returns the algebraic variable, at the given index, computed by this :class:`AnalyserEquation` object.";
 
+%feature("docstring") libcellml::AnalyserEquation::externalCount
+"Returns the number of external variables computed by this :class:`AnalyserEquation` object.";
+
+%feature("docstring") libcellml::AnalyserEquation::externals
+"Returns the external variables computed by this :class:`AnalyserEquation` object.";
+
+%feature("docstring") libcellml::AnalyserEquation::external
+"Returns the external variable, at the given index, computed by this :class:`AnalyserEquation` object.";
+
 %{
 #include "libcellml/analyserequation.h"
 %}

src/bindings/interface/analysermodel.i

@@ -61,6 +61,15 @@
 %feature("docstring") libcellml::AnalyserModel::algebraic
 "Returns the algebraic variable, specified by index, contained by this :class:`AnalyserModel` object.";
 
+%feature("docstring") libcellml::AnalyserModel::externalCount
+"Returns the number of external variables contained by this :class:`AnalyserModel` object.";
+
+%feature("docstring") libcellml::AnalyserModel::externals
+"Returns the external variables contained by this :class:`AnalyserModel` object.";
+
+%feature("docstring") libcellml::AnalyserModel::external
+"Returns the external variable, specified by index, contained by this :class:`AnalyserModel` object.";
+
 %feature("docstring") libcellml::AnalyserModel::equationCount
 "Returns the number of equations contained by this :class:`AnalyserModel` object.";