PineForge v0.13.1-379-g9b50973
Deterministic PineScript v6 backtest runtime — C ABI reference
Loading...
Searching...
No Matches
pineforge::native_run_spec_v3::IntrabarPath Struct Reference

An owned lower-timeframe execution path. More...

#include <native_run_spec.hpp>

Data Structures

struct  lower_tf
 A RETAINED finer feed: the host's own lower-timeframe bars, the literal they are at, and the sampling policy over them. More...
 
struct  none
 No intrabar path: the confirmed OHLC waypoints are the whole modeled walk, and on_native_sub_bar never fires. More...
 
struct  synthesized
 A synthesized path has no retained lower feed. More...
 

Public Types

enum class  SampleEligibility : std::uint32_t {
  ContinuousSegments = 0 ,
  DistributionSamples = 1
}
 
using value_type = std::variant<none, lower_tf, synthesized>
 The three alternatives as one value.
 

Public Member Functions

bool is_none () const noexcept
 Whether this run declares no intrabar path at all.
 
const lower_tflower () const noexcept
 The retained finer feed, or nullptr when this is not the lower_tf alternative.
 
lower_tflower () noexcept
 The mutable retained finer feed, or nullptr; a staged spec's feed is copied by configure_native, so mutating it afterwards changes nothing about the run.
 
const synthesizedsynthesized_path () const noexcept
 The synthesized sampling policy, or nullptr when this is not that alternative.
 
synthesizedsynthesized_path () noexcept
 The mutable synthesized sampling policy, or nullptr.
 

Data Fields

value_type value = none{}
 

Detailed Description

An owned lower-timeframe execution path.

It is deliberately a run-spec value rather than a caller borrow: public begin arguments expire when the begin call returns, whereas native matching may need the lower bars later while sealing an aggregated script bar.

Definition at line 377 of file native_run_spec.hpp.

Member Typedef Documentation

◆ value_type

The three alternatives as one value.

Exhaustive; use the accessors below rather than std::get_if at call sites.

Definition at line 415 of file native_run_spec.hpp.

Member Enumeration Documentation

◆ SampleEligibility

Enumerator
ContinuousSegments 

Native hosts retain continuous matching between generated samples unless they explicitly request point-only sample eligibility.

DistributionSamples 

Definition at line 381 of file native_run_spec.hpp.

Member Function Documentation

◆ is_none()

bool pineforge::native_run_spec_v3::IntrabarPath::is_none ( ) const
inlinenoexcept

Whether this run declares no intrabar path at all.

Definition at line 420 of file native_run_spec.hpp.

References value.

◆ lower() [1/2]

const lower_tf * pineforge::native_run_spec_v3::IntrabarPath::lower ( ) const
inlinenoexcept

The retained finer feed, or nullptr when this is not the lower_tf alternative.

Definition at line 422 of file native_run_spec.hpp.

References value.

◆ lower() [2/2]

lower_tf * pineforge::native_run_spec_v3::IntrabarPath::lower ( )
inlinenoexcept

The mutable retained finer feed, or nullptr; a staged spec's feed is copied by configure_native, so mutating it afterwards changes nothing about the run.

Definition at line 425 of file native_run_spec.hpp.

References value.

◆ synthesized_path() [1/2]

const synthesized * pineforge::native_run_spec_v3::IntrabarPath::synthesized_path ( ) const
inlinenoexcept

The synthesized sampling policy, or nullptr when this is not that alternative.

Definition at line 427 of file native_run_spec.hpp.

References value.

◆ synthesized_path() [2/2]

synthesized * pineforge::native_run_spec_v3::IntrabarPath::synthesized_path ( )
inlinenoexcept

The mutable synthesized sampling policy, or nullptr.

Definition at line 431 of file native_run_spec.hpp.

References value.

Field Documentation

◆ value

value_type pineforge::native_run_spec_v3::IntrabarPath::value = none{}

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