Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
aidge_core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Eclipse Projects
aidge
aidge_core
Commits
be4955cd
Commit
be4955cd
authored
6 months ago
by
Octave Perrin
Browse files
Options
Downloads
Patches
Plain Diff
continuation
parent
1d280972
No related branches found
No related tags found
1 merge request
!245
aidge_core#194: Add documentation for GraphView
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
include/aidge/graph/GraphView.hpp
+15
-5
15 additions, 5 deletions
include/aidge/graph/GraphView.hpp
with
15 additions
and
5 deletions
include/aidge/graph/GraphView.hpp
+
15
−
5
View file @
be4955cd
...
@@ -183,10 +183,16 @@ public:
...
@@ -183,10 +183,16 @@ public:
/** @brief Get reference to the set of output Nodes. */
/** @brief Get reference to the set of output Nodes. */
std
::
set
<
NodePtr
>
outputNodes
()
const
;
std
::
set
<
NodePtr
>
outputNodes
()
const
;
/** @brief Assess if the given Node is an input Node of the GraphView object. */
/** @brief Assess if the given Node is an input Node of the GraphView object.
* @param Node The tested Node
* @return bool True if the Node is an input of the GraphView, False otherwise
*/
bool
isInputNode
(
const
NodePtr
&
nodePtr
)
const
;
bool
isInputNode
(
const
NodePtr
&
nodePtr
)
const
;
/** @brief Assess if the given Node is an output Node of the GraphView object. */
/** @brief Assess if the given Node is an output Node of the GraphView object.
* @param Node The tested Node
* @return bool True if the Node is an output of the GraphView, False otherwise
*/
bool
isOutputNode
(
const
NodePtr
&
nodePtr
)
const
;
bool
isOutputNode
(
const
NodePtr
&
nodePtr
)
const
;
/**
/**
...
@@ -229,6 +235,7 @@ public:
...
@@ -229,6 +235,7 @@ public:
* @return const std::vector<std::pair<NodePtr, IOIndex_t>>&
* @return const std::vector<std::pair<NodePtr, IOIndex_t>>&
*/
*/
inline
const
std
::
vector
<
std
::
pair
<
NodePtr
,
IOIndex_t
>>&
getOrderedInputs
()
const
noexcept
{
return
mInputNodes
;
};
inline
const
std
::
vector
<
std
::
pair
<
NodePtr
,
IOIndex_t
>>&
getOrderedInputs
()
const
noexcept
{
return
mInputNodes
;
};
/**
/**
* @brief Get outputs of the current GraphView with their associated id.
* @brief Get outputs of the current GraphView with their associated id.
* The rank of the nodes are their rank in the vector.
* The rank of the nodes are their rank in the vector.
...
@@ -282,8 +289,8 @@ public:
...
@@ -282,8 +289,8 @@ public:
* @param nodeName Name of the Node of which to show the output.
* @param nodeName Name of the Node of which to show the output.
* @return std::vector<std::vector<std::pair<NodePtr, IOIndex_t>>>
* @return std::vector<std::vector<std::pair<NodePtr, IOIndex_t>>>
*/
*/
std
::
vector
<
std
::
vector
<
std
::
pair
<
NodePtr
,
IOIndex_t
>>>
outputs
(
std
::
vector
<
std
::
vector
<
std
::
pair
<
NodePtr
,
IOIndex_t
>>>
outputs
(
const
std
::
string
&
nodeName
)
const
;
const
std
::
string
&
nodeName
)
const
;
/**
/**
* @brief Assert Datatype, Backend, data format and dimensions along the GraphView are coherent.
* @brief Assert Datatype, Backend, data format and dimensions along the GraphView are coherent.
* If not, apply the required transformations.
* If not, apply the required transformations.
...
@@ -324,10 +331,12 @@ public:
...
@@ -324,10 +331,12 @@ public:
* @param DeviceIdx_t: device Backend device to be set
* @param DeviceIdx_t: device Backend device to be set
*/
*/
void
setBackend
(
const
std
::
string
&
backend
,
const
DeviceIdx_t
device
=
0
)
const
;
void
setBackend
(
const
std
::
string
&
backend
,
const
DeviceIdx_t
device
=
0
)
const
;
/** @brief Set the same data type for each Operator of the GraphView object's Nodes.
/** @brief Set the same data type for each Operator of the GraphView object's Nodes.
* @param DataType: datatype DataType to be set
* @param DataType: datatype DataType to be set
*/
*/
void
setDataType
(
const
DataType
&
datatype
)
const
;
void
setDataType
(
const
DataType
&
datatype
)
const
;
/** @brief Set the same data format for each Operator of the GraphView object's Nodes.
/** @brief Set the same data format for each Operator of the GraphView object's Nodes.
* @param DataFormat: dataformat DataFormat to be set
* @param DataFormat: dataformat DataFormat to be set
*/
*/
...
@@ -343,6 +352,7 @@ public:
...
@@ -343,6 +352,7 @@ public:
* @return std::set<NodePtr>
* @return std::set<NodePtr>
*/
*/
std
::
set
<
NodePtr
>
getParents
()
const
;
std
::
set
<
NodePtr
>
getParents
()
const
;
/**
/**
* @brief Get parents Nodes of the specified Node.
* @brief Get parents Nodes of the specified Node.
* @param nodeName Name of the Node.
* @param nodeName Name of the Node.
...
@@ -373,7 +383,6 @@ public:
...
@@ -373,7 +383,6 @@ public:
*/
*/
std
::
vector
<
std
::
vector
<
NodePtr
>>
getChildren
(
const
std
::
string
nodeName
)
const
;
std
::
vector
<
std
::
vector
<
NodePtr
>>
getChildren
(
const
std
::
string
nodeName
)
const
;
/**
/**
* @brief Get children Nodes of the specified Node.
* @brief Get children Nodes of the specified Node.
* @param otherNode The Node
* @param otherNode The Node
...
@@ -704,6 +713,7 @@ private:
...
@@ -704,6 +713,7 @@ private:
* @return GraphView GraphView containing all nodes with a path to node.
* @return GraphView GraphView containing all nodes with a path to node.
*/
*/
std
::
shared_ptr
<
GraphView
>
getConnectedGraphView
(
std
::
shared_ptr
<
Node
>
node
);
std
::
shared_ptr
<
GraphView
>
getConnectedGraphView
(
std
::
shared_ptr
<
Node
>
node
);
}
// namespace Aidge
}
// namespace Aidge
#endif
/* AIDGE_CORE_GRAPH_GRAPHVIEW_H_ */
#endif
/* AIDGE_CORE_GRAPH_GRAPHVIEW_H_ */
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment