A11 (C++ runtime)
Native C++ implementation of the A11 streaming action runtime
Loading...
Searching...
No Matches
a11::flow::graph::Ref Struct Reference

One plan stream. More...

#include <cpp/a11/flow/graph.h>

Public Attributes

StepId phase_gate = kNone
 
RefKind kind = RefKind::kExpr
 
std::string label
 How a reader would say it: search.hits | truncate 200.
 
BodyId owner = kNone
 The body this belongs to, which is where it is materialised.
 
bool writable = false
 Whether this flow may write the stream.
 
bool unary = false
 Whether the stream provably carries at most one value.
 
long long skip = 0
 Values skipped before fan-out; multiple skip n statements accumulate.
 
std::string name
 kFlowPort, kCallPort, kNode: the port or node name.
 
syntax::PortDirection direction = syntax::PortDirection::kInput
 kFlowPort, kCallPort: which side it is on.
 
bool status_port = false
 kFlowPort, kCallPort: write canonical status chunks here.
 
StepId call = kNone
 kCallPort: the call it belongs to.
 
ExprId id_expr = kNone
 kNode: the id expression it attaches to, and the map it lands in.
 
std::string node_map
 
RefId subject = kNone
 kNodeId: the node. kStatus: the node or port it is the outcome of.
 
StepId subject_step = kNone
 kStatus: the call or barrier it is the outcome of.
 
std::string header
 kHeader: the header name, and the default when it was not sent.
 
ExprId expr = kNone
 kExpr: the expression evaluated once.
 
RefId source = kNone
 kDerived: what it reads, and the stage applied to it.
 
Stage stage
 
std::string role
 kBound: which of a loop's streams this is – item, index, carry.
 
StepId bound_by = kNone
 
std::vector< RefId > sources
 kZip sources follow tuple order; kMerge follows arrival order.
 

Detailed Description

One plan stream.

kind determines which fields apply. [Graph::Upstreams] and [Graph::ValueRefs] expose its dependencies.

Member Data Documentation

◆ bound_by

StepId a11::flow::graph::Ref::bound_by = kNone

◆ call

StepId a11::flow::graph::Ref::call = kNone

kCallPort: the call it belongs to.

◆ direction

syntax::PortDirection a11::flow::graph::Ref::direction = syntax::PortDirection::kInput

kFlowPort, kCallPort: which side it is on.

◆ expr

ExprId a11::flow::graph::Ref::expr = kNone

kExpr: the expression evaluated once.

◆ header

std::string a11::flow::graph::Ref::header

kHeader: the header name, and the default when it was not sent.

◆ id_expr

ExprId a11::flow::graph::Ref::id_expr = kNone

kNode: the id expression it attaches to, and the map it lands in.

◆ kind

RefKind a11::flow::graph::Ref::kind = RefKind::kExpr

◆ label

std::string a11::flow::graph::Ref::label

How a reader would say it: search.hits | truncate 200.

◆ name

std::string a11::flow::graph::Ref::name

kFlowPort, kCallPort, kNode: the port or node name.

◆ node_map

std::string a11::flow::graph::Ref::node_map

◆ owner

BodyId a11::flow::graph::Ref::owner = kNone

The body this belongs to, which is where it is materialised.

◆ phase_gate

StepId a11::flow::graph::Ref::phase_gate = kNone

◆ role

std::string a11::flow::graph::Ref::role

kBound: which of a loop's streams this is – item, index, carry.

◆ skip

long long a11::flow::graph::Ref::skip = 0

Values skipped before fan-out; multiple skip n statements accumulate.

◆ source

RefId a11::flow::graph::Ref::source = kNone

kDerived: what it reads, and the stage applied to it.

◆ sources

std::vector<RefId> a11::flow::graph::Ref::sources

kZip sources follow tuple order; kMerge follows arrival order.

◆ stage

Stage a11::flow::graph::Ref::stage

◆ status_port

bool a11::flow::graph::Ref::status_port = false

kFlowPort, kCallPort: write canonical status chunks here.

◆ subject

RefId a11::flow::graph::Ref::subject = kNone

kNodeId: the node. kStatus: the node or port it is the outcome of.

◆ subject_step

StepId a11::flow::graph::Ref::subject_step = kNone

kStatus: the call or barrier it is the outcome of.

◆ unary

bool a11::flow::graph::Ref::unary = false

Whether the stream provably carries at most one value.

Defaults to false when cardinality is unknown.

◆ writable

bool a11::flow::graph::Ref::writable = false

Whether this flow may write the stream.


The documentation for this struct was generated from the following file: