Epok Engine

EPOK RUNTIME

epok::instrument::preparation::Cache::prepare

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Performs `prepare` as part of the instrument preparation module.

Belongs to
epok::instrument::preparation::Cache
Header
instrument_preparation.hpp
Overloads
1

Declaration

Declaration
bool prepare(const BankView& bank,const sequence::Event* events,uint32_t size,uint16_t ppqn)

Performs `prepare` as part of the instrument preparation module.

ParameterTypeMeaning
bankconst BankView &Not documented; consult the linked header.
eventsconst sequence::Event *Not documented; consult the linked header.
sizeuint32_tNot documented; consult the linked header.
ppqnuint16_tNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "instrument_preparation.hpp"

// Assume these named values have been initialized with valid data:
// const BankView & bank
// const sequence::Event * events
// uint32_t size
// uint16_t ppqn

epok::instrument::preparation::Cache& object = /* obtain a valid instance */;

auto result = object.prepare(bank, events, size, ppqn);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/instrument_preparation.hpp:101

Related members