From 8e2a69e2dde4db012be5c713b72d65b2f6302f31 Mon Sep 17 00:00:00 2001 From: Robert Chisholm Date: Fri, 15 Dec 2023 08:59:11 +0000 Subject: [PATCH] Pete changes --- .../DeviceEnvironmentDirectedGraph.cuh | 26 +++++++++---------- .../HostEnvironmentDirectedGraph.cuh | 2 +- src/CMakeLists.txt | 4 +-- src/flamegpu/io/JSONGraphReader.cpp | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/include/flamegpu/runtime/environment/DeviceEnvironmentDirectedGraph.cuh b/include/flamegpu/runtime/environment/DeviceEnvironmentDirectedGraph.cuh index 92fc4baac..cdd88bbb1 100644 --- a/include/flamegpu/runtime/environment/DeviceEnvironmentDirectedGraph.cuh +++ b/include/flamegpu/runtime/environment/DeviceEnvironmentDirectedGraph.cuh @@ -14,7 +14,7 @@ class DeviceEnvironmentDirectedGraph { public: /** - * This class is created when a vertex is provided to DeviceEnvironmentDirectedGraph::edgesLeaving()(id_t) + * This class is created when a vertex is provided to DeviceEnvironmentDirectedGraph::outEdges()(id_t) * It provides iterator access to the subset of edges found leaving the specified vertex * * @see DeviceEnvironmentDirectedGraph::outEdges()(id_t) @@ -44,7 +44,7 @@ class DeviceEnvironmentDirectedGraph { public: /** - * Constructs a message and directly initialises all of it's member variables + * Constructs an edge and directly initialises all of it's member variables * @note See member variable documentation for their purposes */ __device__ Edge(const OutEdgeFilter&parent, const unsigned int&_edge_index) @@ -61,11 +61,11 @@ class DeviceEnvironmentDirectedGraph { /** * Inequality operator * Returns inverse of equality operator - * @see operator==(const Message&) + * @see operator==(const Edge&) */ __device__ bool operator!=(const Edge& rhs) const { return !(*this == rhs); } /** - * Updates the message to return variables from the next message in the message list + * Updates the edge to return variables from the next edge leaving the vertex * @return Returns itself */ __device__ Edge& operator++() { ++edge_index; return *this; } @@ -115,7 +115,7 @@ class DeviceEnvironmentDirectedGraph { /** * Constructor * This iterator is constructed by DeviceEnvironmentDirectedGraph::OutEdgeFilter::begin()(id_t) - * @see DeviceEnvironmentDirectedGraph::edgesLeaving()(id_t) + * @see DeviceEnvironmentDirectedGraph::outEdges()(id_t) */ __device__ iterator(const OutEdgeFilter &parent, const unsigned int &cell_index) : _edge(parent, cell_index) { @@ -170,7 +170,7 @@ class DeviceEnvironmentDirectedGraph { return iterator(*this, bucket_begin - 1); } /** - * Returns an iterator to the position beyond the end of the edge list subset + * Returns an iterator to the position beyond the end of the edge list subset leaving the vertex * @note This iterator is the same for all edge list subsets */ inline __device__ iterator end(void) const { @@ -195,7 +195,7 @@ class DeviceEnvironmentDirectedGraph { const detail::curve::Curve::VariableHash graph_hash; }; /** - * This class is created when a vertex is provided to DeviceEnvironmentDirectedGraph::edgesLeaving()(id_t) + * This class is created when a vertex is provided to DeviceEnvironmentDirectedGraph::inEdges()(id_t) * It provides iterator access to the subset of edges found leaving the specified vertex * * @see DeviceEnvironmentDirectedGraph::inEdges()(id_t) @@ -230,7 +230,7 @@ class DeviceEnvironmentDirectedGraph { public: /** - * Constructs a message and directly initialises all of it's member variables + * Constructs an edge and directly initialises all of it's member variables * @note See member variable documentation for their purposes */ __device__ Edge(const InEdgeFilter&parent, const unsigned int&_ipbm_index) @@ -249,11 +249,11 @@ class DeviceEnvironmentDirectedGraph { /** * Inequality operator * Returns inverse of equality operator - * @see operator==(const Message&) + * @see operator==(const Edge&) */ __device__ bool operator!=(const Edge& rhs) const { return !(*this == rhs); } /** - * Updates the message to return variables from the next edge in the message list + * Updates the edge to return variables from the next edge joining the vertex * @return Returns itself */ __device__ Edge& operator++() { @@ -306,7 +306,7 @@ class DeviceEnvironmentDirectedGraph { /** * Constructor * This iterator is constructed by DeviceEnvironmentDirectedGraph::InEdgeFilter::begin()(id_t) - * @see DeviceEnvironmentDirectedGraph::edgesJoining()(id_t) + * @see DeviceEnvironmentDirectedGraph::inEdges()(id_t) */ __device__ iterator(const InEdgeFilter &parent, const unsigned int &cell_index) : _edge(parent, cell_index) { @@ -354,14 +354,14 @@ class DeviceEnvironmentDirectedGraph { */ inline __device__ InEdgeFilter(detail::curve::Curve::VariableHash _graph_hash, const id_t &vertex_index); /** - * Returns an iterator to the start of the message list subset about the search origin + * Returns an iterator to the start of the in edge list subset joining the vertex */ inline __device__ iterator begin(void) const { // Bin before initial bin, as the constructor calls increment operator return iterator(*this, bucket_begin - 1); } /** - * Returns an iterator to the position beyond the end of the edge list subset + * Returns an iterator to the position beyond the end of the edge list subset joining the vertex * @note This iterator is the same for all edge list subsets */ inline __device__ iterator end(void) const { diff --git a/include/flamegpu/runtime/environment/HostEnvironmentDirectedGraph.cuh b/include/flamegpu/runtime/environment/HostEnvironmentDirectedGraph.cuh index 602a8903f..350548707 100644 --- a/include/flamegpu/runtime/environment/HostEnvironmentDirectedGraph.cuh +++ b/include/flamegpu/runtime/environment/HostEnvironmentDirectedGraph.cuh @@ -91,7 +91,7 @@ class HostEnvironmentDirectedGraph { VertexMap vertices(); /** * Returns a map for accessing edges - * The edges are accessed via their ID, and will be created if they don't already exist + * The edges are accessed via their source-destination pair, and will be created if they don't already exist * It is necessary to first call setEdgeCount() to initialise the storage for edges */ EdgeMap edges(); diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 388d75bbb..99385c155 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -96,11 +96,11 @@ endif() option(FLAMEGPU_ENABLE_LINT_FLAMEGPU "Enable creation of the lint_flamegpu target" ${FLAMEGPU_ENABLE_LINT_FLAMEGPU_DEFAULT}) unset(FLAMEGPU_ENABLE_LINT_FLAMEGPU_DEFAULT) -# Option to make put glm on the include path +# Option to enable GLM support and put GLM on the include path option(FLAMEGPU_ENABLE_GLM "Experimental: Make GLM available to flamegpu2 projects on the include path" OFF) mark_as_advanced(FLAMEGPU_ENABLE_GLM) -# Option to make put glm on the include path +# Option to enable the "advanced API" - access to high performance internals that may break at any time option(FLAMEGPU_ENABLE_ADVANCED_API "Enable advanced API functionality (C++ only), providing access to internal sim components for high-performance extensions." OFF) mark_as_advanced(FLAMEGPU_ENABLE_ADVANCED_API) diff --git a/src/flamegpu/io/JSONGraphReader.cpp b/src/flamegpu/io/JSONGraphReader.cpp index 6499a8ff2..fb40795a8 100644 --- a/src/flamegpu/io/JSONGraphReader.cpp +++ b/src/flamegpu/io/JSONGraphReader.cpp @@ -76,7 +76,7 @@ class JSONAdjacencyGraphSizeReader : public rapidjson::BaseReaderHandler