|
1 | 1 | # API |
2 | 2 |
|
3 | | -# Express |
4 | | - |
5 | | -This part contains basic convenience functions for creating and running Mango.jl simulations. |
6 | | - |
7 | | -```@autodocs |
8 | | -Modules = [Mango] |
9 | | -Private = false |
10 | | -Pages = ["express/api.jl"] |
11 | | -``` |
12 | | - |
13 | | -# Agent and Roles |
14 | | - |
15 | | -Here, the API for the agent structs created with @agent/@role is listed. |
16 | | - |
17 | | -```@autodocs |
18 | | -Modules = [Mango] |
19 | | -Private = false |
20 | | -Pages = ["agent/api.jl", "agent/core.jl", "agent/role.jl", "agent/services.jl"] |
21 | | -Order = [:macro, :function, :constant, :type, :module] |
22 | | -``` |
23 | | - |
24 | | -# Real time container |
25 | | - |
26 | | -This part contains the API related to the container construction, access and management. |
| 3 | +# Algorithm Core Functions |
27 | 4 |
|
28 | 5 | ```@autodocs |
29 | | -Modules = [Mango] |
| 6 | +Modules = [DistributedResourceOptimization] |
30 | 7 | Private = false |
31 | | -Pages = ["container/api.jl", "container/core.jl", "container/mqtt.jl", "container/protocol.jl", "container/tcp.jl"] |
| 8 | +Pages = ["algorithm/core.jl"] |
32 | 9 | ``` |
33 | 10 |
|
34 | | -# Simulation |
35 | | - |
36 | | -In the following the APIs regarding the simulation world are listed. |
| 11 | +# Carrier Core |
37 | 12 |
|
38 | 13 | ```@autodocs |
39 | | -Modules = [Mango] |
| 14 | +Modules = [DistributedResourceOptimization] |
40 | 15 | Private = false |
41 | | -Pages = ["simulation/container.jl", "simulation/communication.jl", "simulation/tasks.jl", "simulation/world.jl"] |
| 16 | +Pages = ["carrier/core.jl"] |
42 | 17 | ``` |
43 | 18 |
|
44 | | -# Simulation Environment |
45 | | - |
46 | | -In the following the APIs regarding the simulation environment are listed. |
| 19 | +# Mango Carrier |
47 | 20 |
|
48 | 21 | ```@autodocs |
49 | | -Modules = [Mango] |
| 22 | +Modules = [DistributedResourceOptimization] |
50 | 23 | Private = false |
51 | | -Pages = ["environment/api.jl", "environment/core.jl"] |
| 24 | +Pages = ["carrier/mango.jl"] |
52 | 25 | ``` |
53 | 26 |
|
54 | | -# Scheduling |
55 | 27 |
|
56 | | -In the following the APIs for scheduling TaskData is listed. |
| 28 | +# ADMM Sharing |
57 | 29 |
|
58 | 30 | ```@autodocs |
59 | | -Modules = [Mango] |
| 31 | +Modules = [DistributedResourceOptimization] |
60 | 32 | Private = false |
61 | | -Pages = ["util/scheduling.jl"] |
| 33 | +Pages = ["algorithm/admm/sharing_admm.jl"] |
62 | 34 | ``` |
63 | 35 |
|
64 | | -# Topology |
65 | | - |
66 | | -In the following the APIs for creating, aplying and using topologies is listed. |
| 36 | +# ADMM Consensus |
67 | 37 |
|
68 | 38 | ```@autodocs |
69 | | -Modules = [Mango] |
| 39 | +Modules = [DistributedResourceOptimization] |
70 | 40 | Private = false |
71 | | -Pages = ["util/topology.jl"] |
| 41 | +Pages = ["algorithm/admm/consensus_admm.jl"] |
72 | 42 | ``` |
73 | 43 |
|
74 | | -# Encoding/Decoding |
75 | | - |
76 | | -In the following the built-in functions for encoding and decoding messages are listed. |
| 44 | +# ADMM Flex |
77 | 45 |
|
78 | 46 | ```@autodocs |
79 | | -Modules = [Mango] |
| 47 | +Modules = [DistributedResourceOptimization] |
80 | 48 | Private = false |
81 | | -Pages = ["util/encode_decode.jl"] |
| 49 | +Pages = ["algorithm/admm/conflex_actor.jl"] |
82 | 50 | ``` |
83 | | - |
84 | | -# Misc |
85 | | - |
86 | | - |
87 | | -```@autodocs |
88 | | -Modules = [Mango] |
89 | | -Private = false |
90 | | -Pages = ["util/datastructures_util.jl"] |
91 | | -``` |
0 commit comments