From 1f86559c3e6ec8aecb152bc493fed9f4513a6379 Mon Sep 17 00:00:00 2001
From: Octave Perrin <operrin@lrtechnologies.fr>
Date: Thu, 24 Oct 2024 10:36:00 +0200
Subject: [PATCH] continuation
---
include/aidge/graph/Node.hpp | 59 +++++++++++++++++-------------------
1 file changed, 27 insertions(+), 32 deletions(-)
diff --git a/include/aidge/graph/Node.hpp b/include/aidge/graph/Node.hpp
index 715b96a82..d4675bd4b 100644
--- a/include/aidge/graph/Node.hpp
+++ b/include/aidge/graph/Node.hpp
@@ -41,16 +41,6 @@ class GraphView;
/**
* @brief Object carrying the topological information of the computational graph.
- * A Node contains :
- * - mName: the name of the Node, should be unique
- * - mViews: a set of pointers to GraphView instances including this Node instance
- * - mOperator: a pointer to the Operator associated to the node
- * - mParents: a vector of parent nodes, which are its inputs
- * - mIdOutParents: a vector of indexes, which tells for all the parent nodes from which of their output we take the value
- * - mChildren: a vector of vector of children nodes, which lists all the recipient nodes, for all of the outputs
- * - mIdInChildren: a vector of vector of indexes, which gives for all the recipient nodes in which of their input the current value is taken
- * - mforward: ?
- * - mbackward: ?
*/
class Node : public std::enable_shared_from_this<Node> {
private:
@@ -64,8 +54,7 @@ private:
return sharedA < sharedB; // shared_ptr has a valid comparison operator
}
};
- std::shared_ptr<DynamicAttributes> mAttrs;
- std::string mName; /** Name of the Node. It should be unique. */
+ std::string mName; /** Name of the Node. Should be unique. */
std::set<std::weak_ptr<GraphView>, weakCompare> mViews; /** Set of pointers to GraphView instances including this Node instance. */
const std::shared_ptr<Operator> mOperator; // Pointer to the associated Operator
@@ -79,19 +68,7 @@ private:
std::deque<std::function<bool()>> mBackward;
public:
-
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
Node() = delete;
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
-
- /**
- * @brief Construct a new Node object associated with the input Operator.
- * @param op Operator giving the Node its number of connections.
- * @param attrs Attributes for the Node.
- */
- Node(std::shared_ptr<Operator> op, std::shared_ptr<DynamicAttributes> attrs);
- Node(std::shared_ptr<Operator> op, const DynamicAttributes& attrs);
/**
* @brief Construct a new Node object associated with the input Operator.
@@ -130,6 +107,7 @@ public:
/**
* @brief Functional operator for user-friendly connection interface using an ordered set of Connectors.
* @param ctors Ordered Connectors linking their associated Node to the input of the current Node with the same index.
+ * length of ctors must be lower than the number of input of the Node
* @return Connector
*/
Connector operator()(const std::vector<Connector> &ctors);
@@ -143,7 +121,7 @@ public:
* @brief Name of the Node.
* @return std::string
*/
- inline std::string name() const noexcept { return (mAttrs->hasAttr("name")) ? mAttrs->getAttr<std::string>("name") : ""; }
+ inline std::string name() const noexcept { return mName; }
/**
* @brief Set the Node name.
@@ -155,8 +133,8 @@ public:
/**
* @brief Given the parameter name generate a new name which is unique
* in all the GraphView which contains this node.
- * To generate the new name the method is called recursively and append
- * the caracter ``_``.
+ * To generate the new name the method appends
+ * the caracter ``_`` until it is unique.
* If no duplicate return name, this is the exit condition.
* @param name Base name to make unique.
* @return A unique name in all the GraphView which contains this one.
@@ -187,7 +165,7 @@ public:
* @brief Get the Operator object of the Node.
* @return std::shared_ptr<Operator>
*/
- inline std::shared_ptr<Operator> getOperator() const { return (*mOperator)(mAttrs); }
+ inline std::shared_ptr<Operator> getOperator() const { return mOperator; }
///////////////////////////////////////////////////////
// TENSOR MANAGEMENT
@@ -246,7 +224,10 @@ public:
return (i < nbInputs()) ? i : gk_IODefaultIndex;
}
-
+ /**
+ * @brief Returns the number of free data inputs of the Node
+ * @return IOIndex_t
+ */
IOIndex_t getNbFreeDataInputs() const;
/**
@@ -334,6 +315,11 @@ public:
mViews.insert(std::weak_ptr<GraphView>(graphPtr));
}
+ /**
+ * @brief Remove a GraphView pointer from the list of GraphView containing
+ * the current Node.
+ * @param graphPtr Pointer to GraphView to remove from the list.
+ */
inline void removeView(const std::shared_ptr<GraphView> &graphPtr) {
mViews.erase(graphPtr);
}
@@ -344,7 +330,7 @@ public:
* @param outId ID of the current Node output to connect to the other Node.
* Default to 0.
* @param otherInId ID of the other Node input to connect to the current Node.
- * Default to the first avaible data input.
+ * Default to the first available data input.
*/
void addChild(NodePtr otherNode,
const IOIndex_t outId = IOIndex_t(0),
@@ -391,6 +377,11 @@ public:
*/
NodePtr popParent(const IOIndex_t inId);
+ /**
+ * @brief unlinks the parent from the Node and replaces it with nullptr (for coherence with remaining parents)
+ * @param inId Input index of the parent to be removed
+ * @return std::bool true if parent has been removed.
+ */
bool removeParent(const IOIndex_t inId);
/**
@@ -401,18 +392,22 @@ public:
*/
std::set<NodePtr> getChildren() const;
+/**
+ * @brief Get all sets of children of the node, grouped by which output of the Node they come from
+ * @returns std::vector<std::vector<std::shared_ptr<Node>>>
+ */
std::vector<std::vector<NodePtr>> getOrderedChildren() const;
/**
* @brief Get the list of children Nodes linked to the output at specified index.
* @param outId Output index.
* @return std::vector<std::shared_ptr<Node>>
- */
+ */>
std::vector<NodePtr> getChildren(const IOIndex_t outId) const;
/**
* @brief Remove registered child from children list of specified output if possible.
- * If so, also remove current Node from child Node from parent.
+ * If so, also remove current Node from child's parent.
* @param std::shared_ptr<Node> Node to remove.
* @param outId Output index. Default 0.
* @return true Child found and removed for given output index.
--
GitLab