Skip to content

Commit ad3cd80

Browse files
Add missing API documentation for exported symbols
- Created API/structural_transformation.md for structural transformation functions - Created API/bipartite_graph.md for graph-related functions - Added missing linearization and analysis functions to System.md - Updated pages.jl to include new documentation files This ensures all 270 exported symbols in ModelingToolkit.jl have documentation references. Generated with Claude Code (https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent b9220f0 commit ad3cd80

File tree

4 files changed

+188
-0
lines changed

4 files changed

+188
-0
lines changed

docs/pages.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ pages = [
3232
"API/variables.md",
3333
"API/model_building.md",
3434
"API/problems.md",
35+
"API/structural_transformation.md",
36+
"API/bipartite_graph.md",
3537
"API/dynamic_opt.md",
3638
"API/codegen.md",
3739
"API/PDESystem.md"],

docs/src/API/System.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,3 +224,28 @@ following functions are useful for manipulating namespacing functionality.
224224
ModelingToolkit.renamespace
225225
ModelingToolkit.namespace_equations
226226
```
227+
228+
## Linearization and Analysis
229+
230+
Functions for linearization and analysis of systems.
231+
232+
```@docs
233+
LinearizationProblem
234+
linearization_ap_transform
235+
get_sensitivity_function
236+
get_comp_sensitivity_function
237+
get_looptransfer_function
238+
get_sensitivity
239+
get_comp_sensitivity
240+
get_looptransfer
241+
open_loop
242+
```
243+
244+
## Additional Equation Classification
245+
246+
```@docs
247+
alg_equations
248+
diff_equations
249+
has_alg_equations
250+
has_diff_equations
251+
```

docs/src/API/bipartite_graph.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Bipartite Graphs
2+
3+
ModelingToolkit uses bipartite graphs to represent relationships between equations and variables in systems. These functions provide tools for working with and analyzing these graphs.
4+
5+
## Graph Types
6+
7+
```@docs
8+
BipartiteGraph
9+
BipartiteEdge
10+
DiCMOBiGraph
11+
DiffGraph
12+
```
13+
14+
## Vertex Operations
15+
16+
```@docs
17+
𝑠vertices
18+
𝑑vertices
19+
has_𝑠vertex
20+
has_𝑑vertex
21+
nsrcs
22+
ndsts
23+
```
24+
25+
## Neighbor Operations
26+
27+
```@docs
28+
𝑠neighbors
29+
𝑑neighbors
30+
set_neighbors!
31+
```
32+
33+
## Edge Operations
34+
35+
```@docs
36+
𝑠edges
37+
𝑑edges
38+
```
39+
40+
## Graph Views and Modifications
41+
42+
```@docs
43+
invview
44+
delete_srcs!
45+
delete_dsts!
46+
```
47+
48+
## Matching Algorithms
49+
50+
```@docs
51+
maximal_matching
52+
construct_augmenting_path!
53+
```
54+
55+
## Dependency Analysis
56+
57+
```@docs
58+
equation_dependencies
59+
variable_dependencies
60+
eqeq_dependencies
61+
varvar_dependencies
62+
map_variables_to_equations
63+
```
64+
65+
## Graph Conversion
66+
67+
```@docs
68+
asgraph
69+
asdigraph
70+
```
71+
72+
## Constants
73+
74+
```@docs
75+
SRC
76+
DST
77+
```
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Structural Transformation
2+
3+
These functions are used for structural analysis and transformation of equation systems, including index reduction, tearing, and other algebraic manipulations used in the simplification process.
4+
5+
## Tearing and Algebraic Simplification
6+
7+
```@docs
8+
tearing
9+
tearing_reassemble
10+
tearing_substitution
11+
torn_system_jacobian_sparsity
12+
find_solvables!
13+
linear_subsys_adjmat!
14+
```
15+
16+
## Index Reduction
17+
18+
```@docs
19+
dae_index_lowering
20+
pantelides!
21+
pantelides_reassemble
22+
dummy_derivative
23+
```
24+
25+
## Consistency Checking
26+
27+
```@docs
28+
check_consistency
29+
```
30+
31+
## Incidence Matrix Operations
32+
33+
```@docs
34+
sorted_incidence_matrix
35+
but_ordered_incidence
36+
```
37+
38+
## Variable Ordering and Masks
39+
40+
```@docs
41+
lowest_order_variable_mask
42+
highest_order_variable_mask
43+
computed_highest_diff_variables
44+
```
45+
46+
## Shift Operations
47+
48+
These functions handle shift operations in discrete-time systems.
49+
50+
```@docs
51+
shift2term
52+
lower_shift_varname
53+
simplify_shifts
54+
distribute_shift
55+
```
56+
57+
## System Structure Types and Functions
58+
59+
```@docs
60+
SystemStructure
61+
TearingState
62+
TransformationState
63+
isdiffvar
64+
isdervar
65+
isalgvar
66+
isdiffeq
67+
algeqs
68+
is_only_discrete
69+
dervars_range
70+
diffvars_range
71+
algvars_range
72+
get_fullvars
73+
system_subset
74+
```
75+
76+
## Graph Types
77+
78+
```@docs
79+
Matching
80+
InducedCondensationGraph
81+
MatchedCondensationGraph
82+
Unassigned
83+
unassigned
84+
```

0 commit comments

Comments
 (0)