Skip to content

Commit 7e375b5

Browse files
SeanMcOwenSeanMcOwen
authored
Merge pull request #106 from BlockScience/update
Update
2 parents 6d403a0 + bb1aaa8 commit 7e375b5

12 files changed

+226
-26
lines changed

‎docs/Functions & Validation Rules/System Functions.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ $$\text{isDirected}: \text{system} \rightarrow \text{Bool}$$
3737
$$\text{isConnected}: \text{system} \rightarrow \text{Bool}$$
3838

3939
### Description
40-
- A function which determines if there is a path between any two nodes
41-
- [NOTE] Do we want it to be that direction matters, i.e. there has to be looping behavior for this to be true (and everything needs to be reached by that loop even if downstream) or have it be that it just means that you couldn't partition the system into two subsystems without breaking a wiring?
40+
- A function which determines if there is a path between any two nodes, in the weakly connected sense
4241

4342
### Python Implementation
4443

‎docs/JSON-Specification/README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@
2828

2929
* [Target](./wire-properties-target.md "The target of the wire/space") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/wire.schema.json#/properties/Target`
3030

31+
* [Untitled object in Processor](./processor-properties-subsystem-properties-port-mappings-items.md) – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items`
32+
33+
* [Untitled object in Processor](./processor-properties-subsystem-properties-terminal-mappings-items.md) – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items`
34+
3135
### Arrays
3236

3337
* [Blocks](./toolbox-properties-blocks.md "A list of blocks in the block diagram protocol that follow the block schema") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/toolbox.schema.json#/properties/Blocks`
@@ -36,6 +40,8 @@
3640

3741
* [Domain](./block-properties-domain.md "The domain of the block which are IDs of spaces") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/block.schema.json#/properties/Domain`
3842

43+
* [Port Mappings](./processor-properties-subsystem-properties-port-mappings.md "This array, which is equal in length to the number of ports on the processor, maps each port to an internal processor within the subsystem and its port index that the port should be passed on to") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings`
44+
3945
* [Ports](./processor-properties-ports.md "The IDs of spaces which must match the domain of the parent block") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Ports`
4046

4147
* [Processors](./workbench-properties-processors.md "A list of processors in the block diagram protocol that follow the processor schema") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/workbench.schema.json#/properties/Processors`
@@ -46,9 +52,9 @@
4652

4753
* [Systems](./workbench-properties-systems.md "A list of systems in the block diagram protocol that follow the system schema") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/workbench.schema.json#/properties/Systems`
4854

49-
* [Terminals](./processor-properties-terminals.md "The IDs of spaces which must match the codomain of the parent block") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Terminals`
55+
* [Terminal Mappings](./processor-properties-subsystem-properties-terminal-mappings.md "This array, which is equal in length to the number of terminals on the processor, maps terminal port to an internal processor within the subsystem and its terminal index that the outer terminal should receive output from") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings`
5056

51-
* [Wires](./processor-properties-subsystem-properties-wires.md "The IDs of the wires that connect the processor ports and terminals to the system ports and terminals") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Wires`
57+
* [Terminals](./processor-properties-terminals.md "The IDs of spaces which must match the codomain of the parent block") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Terminals`
5258

5359
* [Wires](./workbench-properties-wires.md "A list of wires in the block diagram protocol that follow the wire schema") – `https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/workbench.schema.json#/properties/Wires`
5460

docs/JSON-Specification/processor-properties-subsystem-properties-wires-items.md renamed to docs/JSON-Specification/processor-properties-subsystem-properties-port-mappings-items-properties-index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Untitled string in Processor Schema
1+
# Index Schema
22

33
```txt
4-
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Wires/items
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items/properties/Index
55
```
66

7-
7+
The index of the terminal.
88

99
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
1010
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
1111
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
1212

13-
## items Type
13+
## Index Type
1414

15-
`string`
15+
`integer` ([Index](processor-properties-subsystem-properties-port-mappings-items-properties-index.md))

‎docs/JSON-Specification/processor-properties-subsystem-properties-port-mappings-items-properties-processor.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Processor Schema
2+
3+
```txt
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items/properties/Processor
5+
```
6+
7+
The ID of the processor in the system.
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
12+
13+
## Processor Type
14+
15+
`string` ([Processor](processor-properties-subsystem-properties-port-mappings-items-properties-processor.md))

‎docs/JSON-Specification/processor-properties-subsystem-properties-port-mappings-items.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Untitled object in Processor Schema
2+
3+
```txt
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
12+
13+
## items Type
14+
15+
`object` ([Details](processor-properties-subsystem-properties-port-mappings-items.md))
16+
17+
# items Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :---------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| [Processor](#processor) | `string` | Required | cannot be null | [Processor](processor-properties-subsystem-properties-port-mappings-items-properties-processor.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items/properties/Processor") |
22+
| [Index](#index) | `integer` | Required | cannot be null | [Processor](processor-properties-subsystem-properties-port-mappings-items-properties-index.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items/properties/Index") |
23+
24+
## Processor
25+
26+
The ID of the processor in the system.
27+
28+
`Processor`
29+
30+
* is required
31+
32+
* Type: `string` ([Processor](processor-properties-subsystem-properties-port-mappings-items-properties-processor.md))
33+
34+
* cannot be null
35+
36+
* defined in: [Processor](processor-properties-subsystem-properties-port-mappings-items-properties-processor.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items/properties/Processor")
37+
38+
### Processor Type
39+
40+
`string` ([Processor](processor-properties-subsystem-properties-port-mappings-items-properties-processor.md))
41+
42+
## Index
43+
44+
The index of the terminal.
45+
46+
`Index`
47+
48+
* is required
49+
50+
* Type: `integer` ([Index](processor-properties-subsystem-properties-port-mappings-items-properties-index.md))
51+
52+
* cannot be null
53+
54+
* defined in: [Processor](processor-properties-subsystem-properties-port-mappings-items-properties-index.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings/items/properties/Index")
55+
56+
### Index Type
57+
58+
`integer` ([Index](processor-properties-subsystem-properties-port-mappings-items-properties-index.md))

‎docs/JSON-Specification/processor-properties-subsystem-properties-port-mappings.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Port Mappings Schema
2+
3+
```txt
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Port Mappings
5+
```
6+
7+
This array, which is equal in length to the number of ports on the processor, maps each port to an internal processor within the subsystem and its port index that the port should be passed on to.
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
12+
13+
## Port Mappings Type
14+
15+
`object[]` ([Details](processor-properties-subsystem-properties-port-mappings-items.md))

docs/JSON-Specification/processor-properties-subsystem-properties-wires.md renamed to docs/JSON-Specification/processor-properties-subsystem-properties-terminal-mappings-items-properties-index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Wires Schema
1+
# Index Schema
22

33
```txt
4-
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Wires
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items/properties/Index
55
```
66

7-
The IDs of the wires that connect the processor ports and terminals to the system ports and terminals.
7+
The index of the terminal.
88

99
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
1010
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
1111
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
1212

13-
## Wires Type
13+
## Index Type
1414

15-
`string[]`
15+
`integer` ([Index](processor-properties-subsystem-properties-terminal-mappings-items-properties-index.md))

‎docs/JSON-Specification/processor-properties-subsystem-properties-terminal-mappings-items-properties-processor.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Processor Schema
2+
3+
```txt
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items/properties/Processor
5+
```
6+
7+
The ID of the processor in the system.
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
12+
13+
## Processor Type
14+
15+
`string` ([Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-processor.md))

‎docs/JSON-Specification/processor-properties-subsystem-properties-terminal-mappings-items.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Untitled object in Processor Schema
2+
3+
```txt
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
12+
13+
## items Type
14+
15+
`object` ([Details](processor-properties-subsystem-properties-terminal-mappings-items.md))
16+
17+
# items Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :---------------------- | :-------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| [Processor](#processor) | `string` | Required | cannot be null | [Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-processor.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items/properties/Processor") |
22+
| [Index](#index) | `integer` | Required | cannot be null | [Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-index.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items/properties/Index") |
23+
24+
## Processor
25+
26+
The ID of the processor in the system.
27+
28+
`Processor`
29+
30+
* is required
31+
32+
* Type: `string` ([Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-processor.md))
33+
34+
* cannot be null
35+
36+
* defined in: [Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-processor.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items/properties/Processor")
37+
38+
### Processor Type
39+
40+
`string` ([Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-processor.md))
41+
42+
## Index
43+
44+
The index of the terminal.
45+
46+
`Index`
47+
48+
* is required
49+
50+
* Type: `integer` ([Index](processor-properties-subsystem-properties-terminal-mappings-items-properties-index.md))
51+
52+
* cannot be null
53+
54+
* defined in: [Processor](processor-properties-subsystem-properties-terminal-mappings-items-properties-index.md "https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings/items/properties/Index")
55+
56+
### Index Type
57+
58+
`integer` ([Index](processor-properties-subsystem-properties-terminal-mappings-items-properties-index.md))

‎docs/JSON-Specification/processor-properties-subsystem-properties-terminal-mappings.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Terminal Mappings Schema
2+
3+
```txt
4+
https://github.com/BlockScience/bdp-lib/tree/main/src/bdp_lib/schemas/processor.schema.json#/properties/Subsystem/properties/Terminal Mappings
5+
```
6+
7+
This array, which is equal in length to the number of terminals on the processor, maps terminal port to an internal processor within the subsystem and its terminal index that the outer terminal should receive output from.
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [processor.schema.json\*](../../out/bdp_lib/schemas/processor.schema.json "open original schema") |
12+
13+
## Terminal Mappings Type
14+
15+
`object[]` ([Details](processor-properties-subsystem-properties-terminal-mappings-items.md))

0 commit comments

Comments
 (0)