Skip to content

Commit e801b6b

Browse files
committed
Add Interpolation module and extend Core with utilities from CTModels
- New Interpolation module with ctinterpolate functions - Extended Core with matrix_utils, function_utils, macros - Updated docs/api_reference.jl for new modules - Moved DeepWiki tip in index.md
1 parent 5a21c14 commit e801b6b

4 files changed

Lines changed: 34 additions & 5 deletions

File tree

docs/api_reference.jl

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ function generate_api_reference(src_dir::String)
2222
joinpath("Core", "Core.jl"),
2323
joinpath("Core", "default.jl"),
2424
joinpath("Core", "types.jl"),
25+
joinpath("Core", "matrix_utils.jl"),
26+
joinpath("Core", "function_utils.jl"),
27+
joinpath("Core", "macros.jl"),
2528
),
2629
],
2730
exclude=EXCLUDE_SYMBOLS,
@@ -31,6 +34,21 @@ function generate_api_reference(src_dir::String)
3134
title_in_menu="Core",
3235
filename="core",
3336
),
37+
CTBase.automatic_reference_documentation(;
38+
subdirectory="api",
39+
primary_modules=[
40+
CTBase.Interpolation => src(
41+
joinpath("Interpolation", "Interpolation.jl"),
42+
joinpath("Interpolation", "ctinterpolate.jl"),
43+
),
44+
],
45+
exclude=EXCLUDE_SYMBOLS,
46+
public=true,
47+
private=false,
48+
title="Interpolation",
49+
title_in_menu="Interpolation",
50+
filename="interpolation",
51+
),
3452
CTBase.automatic_reference_documentation(;
3553
subdirectory="api",
3654
primary_modules=[

docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# CTBase.jl — Ecosystem Foundation
22

3-
!!! tip "Ask DeepWiki"
4-
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/control-toolbox/CTBase.jl) offers an interactive, AI-generated overview of this codebase. Answers may be inaccurate — use this
5-
reference documentation as the source of truth.
6-
73
```@meta
84
CurrentModule = CTBase
95
```
@@ -20,6 +16,10 @@ It provides the **base layer** shared by all packages: common types, structured
2016
Downstream packages (e.g. [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl))
2117
may re-export selected symbols for convenience.
2218

19+
!!! tip "Ask DeepWiki"
20+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/control-toolbox/CTBase.jl) offers an interactive, AI-generated overview of this codebase. Answers may be inaccurate — use this
21+
reference documentation as the source of truth.
22+
2323
## Submodule overview
2424

2525
| Submodule | Role |

src/CTBase.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,8 @@ using .Descriptions
3232
include(joinpath(@__DIR__, "Extensions", "Extensions.jl"))
3333
using .Extensions
3434

35+
# Interpolation module - interpolation utilities
36+
include(joinpath(@__DIR__, "Interpolation", "Interpolation.jl"))
37+
using .Interpolation
38+
3539
end

src/Core/Core.jl

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ import DocStringExtensions: TYPEDEF, TYPEDSIGNATURES
1313
include("types.jl")
1414
include("default.jl")
1515

16+
# Private utilities
17+
include("function_utils.jl")
18+
include("macros.jl")
19+
20+
# Public utilities
21+
include("matrix_utils.jl")
22+
1623
# Export public API
17-
export ctNumber
24+
export ctNumber, matrix2vec, to_out_of_place, @ensure
1825

1926
end # module

0 commit comments

Comments
 (0)