From 17b8fd4d9fe971d8d8069d9419cd765208b23eb3 Mon Sep 17 00:00:00 2001 From: Enrico Guiraud Date: Mon, 2 Oct 2023 09:00:10 -0600 Subject: [PATCH] [NFC] Clarify why Var does not hold a value --- src/graph.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/graph.h b/src/graph.h index 80c5258..73a5001 100644 --- a/src/graph.h +++ b/src/graph.h @@ -181,7 +181,10 @@ class Const : public Op { const graph_proto::Const& cproto) noexcept; }; -/// A scalar variable: a named placeholder for an input to `evaluate`. +/// A scalar variable: a value-less, named placeholder for a variable in the +/// expression. Note that a Var does not contain any value: it only acts as a +/// placeholder for one in a compute graph. Concrete values for each of the +/// variables used will then be passed to Graph::eval as part of the Inputs. class Var : public Op { std::string name;