C/C++ API Reference (Generated)¶

Generated from public headers under include/lightning_core/.

Regenerate: python scripts/generate_api_reference_docs.py

Metric	Count
Headers scanned	7
Types (enum/struct/class)	56
C++ functions	38
C API functions	25

Header Set¶

• include/lightning_core/core/runtime.hpp
• include/lightning_core/core/attention.hpp
• include/lightning_core/core/graph.hpp
• include/lightning_core/core/tensor.hpp
• include/lightning_core/core/ops/policy.hpp
• include/lightning_core/core/ops.hpp
• include/lightning_core/lightning_core.h

C API Functions¶

Function	Source
lcApplyDefaultSyncPolicy	include/lightning_core/lightning_core.h:127
lcApplySyncPolicy	include/lightning_core/lightning_core.h:126
lcBackendName	include/lightning_core/lightning_core.h:136
lcCheckStructSize	include/lightning_core/lightning_core.h:135
lcDeviceSynchronize	include/lightning_core/lightning_core.h:116
lcFree	include/lightning_core/lightning_core.h:114
lcGetActiveBackendCapabilities	include/lightning_core/lightning_core.h:129
lcGetActiveBackendInterfaceContract	include/lightning_core/lightning_core.h:131
lcGetApiVersion	include/lightning_core/lightning_core.h:132
lcGetApiVersionString	include/lightning_core/lightning_core.h:133
lcGetBackendCapabilities	include/lightning_core/lightning_core.h:128
lcGetBackendInterfaceContract	include/lightning_core/lightning_core.h:130
lcGetDefaultSyncPolicy	include/lightning_core/lightning_core.h:125
lcGetDeviceCount	include/lightning_core/lightning_core.h:117
lcGetErrorString	include/lightning_core/lightning_core.h:137
lcGetMemoryModel	include/lightning_core/lightning_core.h:122
lcGetMemoryModelName	include/lightning_core/lightning_core.h:123
lcGetPreferredDeviceForInference	include/lightning_core/lightning_core.h:118
lcGetPreferredDeviceForTraining	include/lightning_core/lightning_core.h:119
lcGetStructSize	include/lightning_core/lightning_core.h:134
lcIsCudaAvailable	include/lightning_core/lightning_core.h:120
lcIsMetalAvailable	include/lightning_core/lightning_core.h:121
lcMalloc	include/lightning_core/lightning_core.h:113
lcMemcpy	include/lightning_core/lightning_core.h:115
lcSetDefaultSyncPolicy	include/lightning_core/lightning_core.h:124

Types¶

Name	Kind	Source
AttentionConfig	struct	include/lightning_core/core/attention.hpp:9
AttentionImplementation	enum class	include/lightning_core/core/attention.hpp:34
AttentionIoPolicy	struct	include/lightning_core/core/attention.hpp:16
AttentionSession	class	include/lightning_core/core/attention.hpp:86
CostProfileCoefficients	struct	include/lightning_core/core/graph.hpp:1751
DType	enum class	include/lightning_core/core/graph.hpp:24
FusionCostEstimate	struct	include/lightning_core/core/graph.hpp:2131
FusionPassKind	enum class	include/lightning_core/core/graph.hpp:570
FusionPattern	enum class	include/lightning_core/core/graph.hpp:548
GraphExecutionGroup	struct	include/lightning_core/core/graph.hpp:501
GraphFusionDecision	struct	include/lightning_core/core/graph.hpp:592
GraphIR	class	include/lightning_core/core/graph.hpp:618
GraphNode	struct	include/lightning_core/core/graph.hpp:339
GraphPlanCacheStats	struct	include/lightning_core/core/graph.hpp:542
GraphPlanStep	struct	include/lightning_core/core/graph.hpp:349
GraphPlanSummary	struct	include/lightning_core/core/graph.hpp:512
GraphPlannerOptions	struct	include/lightning_core/core/graph.hpp:462
GraphTensorValue	struct	include/lightning_core/core/graph.hpp:333
OpKind	enum class	include/lightning_core/core/graph.hpp:39
OperatorRegistry	class	include/lightning_core/core/graph.hpp:114
OperatorSchema	struct	include/lightning_core/core/graph.hpp:82
PlanCacheEntry	struct	include/lightning_core/core/graph.hpp:1761
PlanCostTelemetry	struct	include/lightning_core/core/graph.hpp:1740
ReasonCode	enum class	include/lightning_core/core/graph.hpp:383
TensorSpec	struct	include/lightning_core/core/graph.hpp:76
ValidationIssue	struct	include/lightning_core/core/graph.hpp:441
ValidationPass	enum class	include/lightning_core/core/graph.hpp:358
ValidationReport	struct	include/lightning_core/core/graph.hpp:450
MatMulMetalResidentSession	class	include/lightning_core/core/ops.hpp:1340
MatrixElemwiseMetalResidentSession	class	include/lightning_core/core/ops.hpp:1382
PackedWeightCacheEntry	struct	include/lightning_core/core/ops.hpp:1044
VectorAddMetalResidentSession	class	include/lightning_core/core/ops.hpp:1419
Conv2dIoPolicy	struct	include/lightning_core/core/ops/policy.hpp:29
MatMulIoPolicy	struct	include/lightning_core/core/ops/policy.hpp:8
MatrixElementwiseIoPolicy	struct	include/lightning_core/core/ops/policy.hpp:15
VectorAddIoPolicy	struct	include/lightning_core/core/ops/policy.hpp:22
BackendCapabilities	struct	include/lightning_core/core/runtime.hpp:99
BackendInterfaceContract	struct	include/lightning_core/core/runtime.hpp:146
ComputeInterfaceContract	struct	include/lightning_core/core/runtime.hpp:113
Device	enum class	include/lightning_core/core/runtime.hpp:11
MemcpyKind	enum class	include/lightning_core/core/runtime.hpp:36
MemoryInterfaceContract	struct	include/lightning_core/core/runtime.hpp:120
MemoryModel	enum class	include/lightning_core/core/runtime.hpp:44
ProfilerInterfaceContract	struct	include/lightning_core/core/runtime.hpp:137
RuntimeTraceEvent	struct	include/lightning_core/core/runtime.hpp:76
RuntimeTraceEventType	enum class	include/lightning_core/core/runtime.hpp:50
RuntimeTraceOpKind	enum class	include/lightning_core/core/runtime.hpp:65
Status	enum class	include/lightning_core/core/runtime.hpp:24
SyncInterfaceContract	struct	include/lightning_core/core/runtime.hpp:129
SyncMode	enum class	include/lightning_core/core/runtime.hpp:86
SyncPolicy	struct	include/lightning_core/core/runtime.hpp:93
WorkloadKind	enum class	include/lightning_core/core/runtime.hpp:17
Layout	enum class	include/lightning_core/core/tensor.hpp:17
TensorT	class	include/lightning_core/core/tensor.hpp:97
TensorT	class	include/lightning_core/core/tensor.hpp:190
TensorViewT	class	include/lightning_core/core/tensor.hpp:100

C++ Function Symbols¶

Function	Source
attentionImplementation	include/lightning_core/core/attention.hpp:41
attentionImplementationName	include/lightning_core/core/attention.hpp:42
attentionUsesFallback	include/lightning_core/core/attention.hpp:43
config	include/lightning_core/core/attention.hpp:90
defaultPolicy	include/lightning_core/core/attention.hpp:94
device	include/lightning_core/core/attention.hpp:91
forward	include/lightning_core/core/attention.hpp:96
setDefaultPolicy	include/lightning_core/core/attention.hpp:93
activeBackendCapabilities	include/lightning_core/core/runtime.hpp:214
activeBackendInterfaceContract	include/lightning_core/core/runtime.hpp:220
applyDefaultSyncPolicy	include/lightning_core/core/runtime.hpp:205
backendCapabilities	include/lightning_core/core/runtime.hpp:211
backendInterfaceContract	include/lightning_core/core/runtime.hpp:217
backendName	include/lightning_core/core/runtime.hpp:183
clearRuntimeTraceEvents	include/lightning_core/core/runtime.hpp:229
defaultSyncPolicy	include/lightning_core/core/runtime.hpp:199
deviceMemoryModel	include/lightning_core/core/runtime.hpp:186
deviceSynchronize	include/lightning_core/core/runtime.hpp:168
deviceSynchronizeWithPolicy	include/lightning_core/core/runtime.hpp:202
encodeRuntimeTraceDispatchDetail	include/lightning_core/core/runtime.hpp:244
freeDevice	include/lightning_core/core/runtime.hpp:161
getDeviceCount	include/lightning_core/core/runtime.hpp:171
getErrorString	include/lightning_core/core/runtime.hpp:260
isCudaAvailable	include/lightning_core/core/runtime.hpp:174
isMetalAvailable	include/lightning_core/core/runtime.hpp:177
isRuntimeTraceEnabled	include/lightning_core/core/runtime.hpp:226
mallocDevice	include/lightning_core/core/runtime.hpp:157
memcpy	include/lightning_core/core/runtime.hpp:165
memoryModelName	include/lightning_core/core/runtime.hpp:189
preferredDeviceFor	include/lightning_core/core/runtime.hpp:180
preloadRuntimeProfileEnv	include/lightning_core/core/runtime.hpp:193
runtimeTraceEventCapacity	include/lightning_core/core/runtime.hpp:235
runtimeTraceEventTypeName	include/lightning_core/core/runtime.hpp:238
runtimeTraceEvents	include/lightning_core/core/runtime.hpp:232
runtimeTraceOpKindName	include/lightning_core/core/runtime.hpp:241
setDefaultSyncPolicy	include/lightning_core/core/runtime.hpp:196
setRuntimeTraceEnabled	include/lightning_core/core/runtime.hpp:223
syncModeName	include/lightning_core/core/runtime.hpp:208