wegamekinglc / Derivatives-Algorithms-Lib

89%

master: 89%

LAST BUILD ON BRANCH feature/docs-cpp-examples

branch: feature/docs-cpp-examples

CHANGE BRANCH

x

Reset

Sync Branches

• feature/docs-cpp-examples
• agent/dal-doc-writer/aec17702
• agent/dal-implementer/28414d3f
• agent/dal-implementer/712bdfc2
• agent/dal-orchestrator/45bdb68f
• agent/document-aad-underdetermined-search
• agent/unified-curve-aad-plan
• agent/unify-curve-interpolation-aad
• agent/update-readme-ci-coverage
• agent/ycinstrument-pricing-perf
• china_2025
• chore/add-doc-writer-to-orchestrator-team
• chore/api-dedup-safe
• chore/ban-volatile-mutable
• chore/curve-dedup-step1
• chore/curve-dedup-step2
• chore/curve-dedup-step3
• chore/curve-hoist-helpers
• chore/dedup-black-bachelier
• chore/dedup-cg-bcg
• chore/dedup-curve
• chore/dedup-dal-public
• chore/dedup-math-structural
• chore/dedup-model-indice
• chore/dedup-script
• chore/fix-all-style-findings
• chore/fix-infra-bugs
• chore/fix-io-protocol-indice-bugs
• chore/fix-math-bugs
• chore/fix-model-bugs
• chore/fix-script-bugs
• chore/phase7-curve-trim
• chore/remove-co-authored-by-from-guides
• chore/review-p2-repo-polish
• chore/simplify-comments-phase1
• chore/simplify-comments-phase2
• chore/simplify-comments-phase3
• chore/simplify-comments-phase4
• chore/simplify-comments-phase5
• chore/simplify-comments-phase6
• chore/simplify-comments-phase8
• chore/simplify-comments-phase9
• chore/trim-curve-comments
• chore/trim-dupire-comments
• chore/trim-script-comments
• chore/trim-small-residuals
• ci/expand-ci-to-public-subprojects
• ci/matrix-workflow
• codex/address-codebase-audit
• codex/claude-to-codex-migration
• codex/codebase-documentation-audit
• codex/dal-agent-skills
• codex/fix-msvc-utf8-charset
• codex/fix-script-compiled-dispatch
• codex/fix-script-engine-math-rendering
• codex/fix-script-mc-double-accumulation
• codex/pde-framework-reimplementation
• codex/pde-scheme-updates
• codex/repository-doc-reconciliation
• codex/root-dal-gitignore
• codex/script-results-lookup-guard
• codex/simplify-codex-guidance
• codex/xccy-resettable-mtm
• codex/xccy-resettable-mtm-plan
• codex/yield-curve-calib-perf
• codex/zero-rate-parameterization
• copilot/add-test-coverage-analysis
• copilot/analyze-test-coverage
• copilot/analyze-test-coverage-again
• copilot/design-web-ui-derivatives-portfolio-management
• copilot/enhance-yield-curve-framework
• copilot/explore-codebase-implementation-plan
• copilot/explore-codebase-yield-curve-modeling
• copilot/fix-comments-in-review-thread
• copilot/override-function-gradient-calibration
• copilot/refactor-script-engine
• copilot/review-pr-199-plan
• dependabot/github_actions/actions/checkout-3
• dependabot/github_actions/actions/checkout-4
• dependabot/github_actions/actions/checkout-5
• dependabot/github_actions/actions/checkout-6
• dependabot/github_actions/actions/checkout-6.0.2
• dependabot/github_actions/actions/checkout-6.0.3
• dependabot/github_actions/actions/checkout-7.0.0
• dependabot/github_actions/actions/checkout-7.0.1
• dependabot/github_actions/actions/setup-node-7.0.0
• dependabot/github_actions/astral-sh/setup-uv-8.2.0
• dependabot/github_actions/astral-sh/setup-uv-8.3.2
• dependabot/github_actions/astral-sh/setup-uv-9.0.0
• dependabot/github_actions/astral-sh/setup-uv-caf0cab7a618c569241d31dcd442f54681755d39
• dependabot/npm_and_yarn/dal-web/frontend/postcss-8.5.23
• dependabot/npm_and_yarn/webui/frontend/multi-f57e1e291f
• dependabot/npm_and_yarn/webui/frontend/vite-8.0.16
• dependabot/uv/dal-web/backend/starlette-1.3.1
• docs/add-black-scholes-methodology
• docs/add-dupire-methodology
• docs/add-matrix-methodology
• docs/add-no-dup-and-comment-style-rules
• docs/add-pde-methodology
• docs/add-quadrature-methodology
• docs/add-random-methodology
• docs/claude-config-sync
• docs/copilot-instructions-guidance
• docs/design-api-shape-dedup
• docs/fix-documentation-consistency
• docs/fix-xccy-plan-stale-paths
• docs/full-quality-pass
• docs/full-review-and-perf-reflect
• docs/improve-readme-formatting
• docs/markdown-table-alignment-and-cleanup
• docs/migrate-curve-comments
• docs/migrate-script-comments
• docs/migrate-small-residuals
• docs/pde-framework-spec
• docs/ptirds-curve-extension-plan
• docs/reconcile-readmes-and-methodology
• docs/restructure-and-webui-rename
• docs/review-p2-consolidation
• docs/script-plan-descope-2-and-5
• docs/simplify-comments-phase0
• docs/simplify-comments-phase7
• docs/xccy-resettable-mtm-plan
• experimental
• feature/aad-methodology-doc
• feature/adept-aad-backend
• feature/adept-expr-tape-tests
• feature/agent-team-design
• feature/agents-tdd-worktree
• feature/analytic-jacobian-backend-abstraction
• feature/analytic-jacobian-rename
• feature/bench-col-width
• feature/benchmark-coverage-gaps
• feature/code-style-fixes
• feature/code-style-functional-rules
• feature/codipack-aad-backend
• feature/codipack-polish
• feature/comment-migration-docs
• feature/coverage-build-flag
• feature/currency-unit-tests
• feature/curve-jacobian-default-analytic
• feature/curve-jacobian-mode-flag
• feature/dal-6-staged-xccy-sensitivity
• feature/dal-doc-writer-agent
• feature/dal-performancer-agent
• feature/dal-pr-review-agent
• feature/dal-python-uv-modernization
• feature/dal-refactor-docs
• feature/dal-refactor-full
• feature/dal-refactor-phase0-phase1
• feature/dal-refactor-phase2
• feature/dal-refactor-phase3
• feature/dal-refactor-phase4
• feature/dal-refactor-phase5
• feature/dal-simplifier-agent
• feature/dal-unit-test-write-agent
• feature/dal-web-async
• feature/dal-web-db-persistence
• feature/dal-web-playwright-e2e
• feature/dal-web-pwsh-scripts
• feature/docs-interp-logdf-calibration-examples
• feature/docs-table-style-guidance
• feature/docs-webui-startup
• feature/enforce-worktree-dal-dev-workflow
• feature/euribor3m-curve-calibration-example
• feature/expose-curve-calibration-to-python-and-excel
• feature/harden-dal-pr-review-agent
• feature/joint-curve-base-layering
• feature/log-linear-interp-and-refactor
• feature/multi-curve-joint-calibration
• feature/normal-expectation-quadrature
• feature/piecewise-linear-curve-tests
• feature/ptirds-log-discount-curve
• feature/ptirds-single-currency-curve
• feature/pybind11-migration
• feature/pybind11-submodule
• feature/remove-precompute-self-param
• feature/rename-skills-dal-prefix
• feature/reorg-miscs-to-subfolders
• feature/rng-precise-default
• feature/script-compiled-evaluator-alignment
• feature/script-compiled-evaluator-alignment-plan
• feature/script-compiled-parity-harness
• feature/script-engine-test-coverage
• feature/serialization-tests-and-skills
• feature/sync-agent-doc-guidance
• feature/webui-redesign-industrial-terminal
• feature/windows-ci-workflow
• feature/ycinstrument-polymorphic-calibration
• feature/yield-curve-calibration
• feature/yield-curve-jacobian-example
• fix/adept-cmake-definitions
• fix/arrayn-dimension-validation
• fix/calibration-build-constant
• fix/cg-shadow-vector-alloc
• fix/code-style-param-naming
• fix/doc-writer-methodology-refs
• fix/holidaydata-concurrent-addcenter
• fix/machinist-cmake-compiler-id
• fix/msvc-ndarray-test-parsing
• fix/nodiscard-warnings-script-tests
• fix/p0-codebase-review-2026-07-17
• fix/p1-codebase-review-2026-07-17
• fix/pr221-followup-style-perf-docs
• fix/priority-8-test-cosmetics-and-guidance
• fix/readme-build-badge
• fix/review-p1-tail-h9
• fix/review-p2-ci-hygiene
• fix/review-p2-exception-safety
• fix/review-p2-factory-unique-ptr
• fix/script-compiled-superequal-shortcircuit
• fix/script-ifelse-bstack-underflow
• fix/sparse-qform-oob
• fix/underdetermined-guidance-and-xad-default
• fix/upgrade-vite-plugin-react-for-vite8
• fix/xccy-calibration-budget
• fix/xccy-calibration-coverage
• fix/yield-curve-inverse-jacobian-units
• master
• old_virtual_dispatch
• perf/bench-infrastructure
• perf/enable-fp-contract-all-compilers
• perf/p1-tape-rewind-p5-zeroadjoints
• perf/p2-sparse-jacobian
• perf/p3-pde-decomp-caching
• perf/p4-sobol-no-polish
• perf/p6-p7-p8-kernel-opts
• perf/p7-p8-fused-sweeps
• refactor/rename-calibratedyieldcurve-to-curveblock
• refs/heads/master
• refs/pull/5/merge
• revert/ptirds-101
• style/dal-web-ruff-format
• test/review-p2-core-test-gaps
• test/review-p2-excel-ivs-gaps
• test/review-p2-frontend-gaps
• test/review-p2-web-backend-gaps
• use_codi
• wegamekinglc-perf-improvements
• worktree-agent-a344d3a27476b1053

Build # 29860366914

Build Type

Pull #250

github

Committed by wegamekinglc

Commit Message

docs: address review feedback on example safety and completeness

Mirror the safety/setup patterns the real example programs use, resolving
all four Copilot review comments on commit 5bf01020:

- black_scholes.md: the Monte Carlo benchmark line referenced discounts,
  fwd, and volStd without defining them, so the fenced block was not
  self-contained. Add the de-annualized setup lines exactly as in
  euorpean_mc.cpp (discounts = exp(-rate*t), cost-of-carry forward, and
  sigma*sqrt(T)), which also shows the "caller supplies forward and
  sigma*sqrt(T)" kernel concretely.
- interpolation.md, log_discount_curve.md, yield_curve.md: the
  dynamic_cast<DiscountLogDF_*> result was dereferenced without a null
  check, which is undefined behavior if the calibration spec is not
  LOG_DISCOUNT. Guard each cast with
  REQUIRE(..., "calibrated curve is not a DiscountLogDF_"), matching
  interpolate_curve.cpp.

python3 .github/scripts/check_docs.py passes for all 39 Markdown files.

Pull Request Pull Request #250: docs: add C++ examples to methodology docs

Coverage Stats

8319 of 9322 relevant lines covered (89.24%)

2851387.18 hits per line