abstractmodel.h

/* Evoplex <https://evoplex.org>
 * Copyright (C) 2016-present - Marcos Cardinot <marcos@cardinot.net>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ABSTRACT_MODEL_H
#define ABSTRACT_MODEL_H

#include <memory.h>
#include <vector>

#include "abstractplugin.h"
#include "abstractgraph.h"
#include "edges.h"
#include "nodes.h"

namespace evoplex {

class AbstractModelInterface : public AbstractPlugin
{
public:
    virtual ~AbstractModelInterface() = default;

    using AbstractPlugin::init;

    virtual void beforeLoop() = 0;

    virtual bool algorithmStep() = 0;

    virtual void afterLoop() = 0;

    virtual Values customOutputs(const Values& inputs) const = 0;
};

class AbstractModel : public AbstractModelInterface
{
    friend class Trial;

public:

    const QString& graphId() const;

    AbstractGraph* graph() const;

    int step() const;

    int lastStep() const;

    inline const Nodes& nodes() const;
    inline Node node(int nodeId) const;

    inline const Edges& edges() const;
    inline const Edge& edge(int edgeId) const;
    inline const Edge& edge(int originId, int neighbourId) const;

    // AbstractModelInterface stuff
    // the default implementation of the functions below do nothing
    inline void beforeLoop() override {}
    inline void afterLoop() override {}
    inline Values customOutputs(const Values& inputs) const override
    { Q_UNUSED(inputs); return Values(); }

protected:
    AbstractModel() = default;
};

/************************************************************************
   AbstractModel: Inline member functions
 ************************************************************************/

inline const Nodes& AbstractModel::nodes() const
{ return graph()->nodes(); }

inline Node AbstractModel::node(int nodeId) const
{ return graph()->node(nodeId); }

inline const Edges& AbstractModel::edges() const
{ return graph()->edges(); }

inline const Edge& AbstractModel::edge(int edgeId) const
{ return graph()->edge(edgeId); }

inline const Edge &AbstractModel::edge(int originId, int neighbourId) const
{ return graph()->edge(originId, neighbourId); }

} // evoplex
#endif // ABSTRACT_MODEL_H