API 参考

API 参考由 include/fincore/ 下的公共头文件通过 Doxygen 和 Breathe 生成。内部 fincore::detail 辅助实现不包含在稳定的 API 参考中。生成的签名与说明和本站点其余内容来自同一源提交。

备注

此处出现的符号表示它属于受维护的公共接口。它并不表示兼容 Python 对象，也不表示在已记录的验收证据之外支持某个平台，或提供任何性能保证。

模块

• 核心类型与错误
• 指标
• 绩效
• 风险
• 优化
• 组合
• 归因
• 因子研究
• 模拟
• 报告
• 运行时
• 可视化
• 扩展

如何阅读参考页

每个模块页都由公共头文件生成，因此阅读顺序就是维护者的书写顺序：

1. 签名。 类型、默认值与模板参数都是字面契约；默认值是契约的一部分，而不是便利。

2. 契约文字。 函数返回什么、以什么单位返回、对缺失或非有限值如何处理。

3. 参数、返回值与抛出。 失败模式被逐一列出，每一条都确实实现，而不是愿望。

4. 所有权。 返回的帧或视图是否拥有数据，以及视图在多长时间内有效。

标识符、命令、路径与公式不翻译：中文页面保留同样的声明，配以中文说明文字。

各模块通用的约定

• 时间戳为 UTC 纳秒；日历辅助函数返回 UTC 零点。

• 除非字段名称另有说明，价格与收益率均为小数。年化方式在每个签名中显式给出。

• dataframe 的输入与输出遵循 DataFrame 子模块的列规则；列名是各契约的一部分。

• 错误通过 fincore::fincore_error 携带稳定的 category、code 与 message；研究路径另有带类型的子类。

• 可选依赖在调用处显式命名；任何接口都不会隐式下载数据或渲染图表。

覆盖情况

公共符号清单记录每个被提取的符号、其模块、源码行号与文档状态。维护者使用 tools/build_api_ledger.py 重新生成它，并要求在文档发布前为每个符号提供说明或经审阅的豁免。清单本身是仓库中的源产物，因此其计数可与同一提交进行比对。

渲染出的签名是规范的 C++ 接口面。与 Python 兼容的行为（包括异常继承和 DataFrame 对象身份）在迁移指南中说明，而不是从生成的声明推断。