Skip to content

Commit cd7dc25

Browse files
heckjheckj
committed
adding curation
1 parent 3846879 commit cd7dc25

File tree

10 files changed

+259
-1
lines changed

10 files changed

+259
-1
lines changed

‎Sources/SwiftViz/Documentation.docc/LinearScale_DoubleScale.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``SwiftViz/LinearScale/DoubleScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/LinearScale/DoubleScale/init(from:to:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/LinearScale/DoubleScale/domainLower``
12+
- ``SwiftViz/LinearScale/DoubleScale/domainHigher``
13+
- ``SwiftViz/LinearScale/DoubleScale/domainExtent``
14+
- ``SwiftViz/LinearScale/DoubleScale/InputType``
15+
- ``SwiftViz/LinearScale/DoubleScale/OutputType``
16+
- ``SwiftViz/LinearScale/DoubleScale/transformType``
17+
- ``SwiftViz/DomainDataTransform``
18+
- ``SwiftViz/LinearScale/DoubleScale/desiredTicks``
19+
20+
### Converting Values
21+
22+
- ``SwiftViz/LinearScale/DoubleScale/scale(_:from:to:)``
23+
- ``SwiftViz/LinearScale/DoubleScale/invert(_:from:to:)``
24+
25+
### Comparing Values
26+
27+
- ``SwiftViz/LinearScale/DoubleScale/domainContains(_:)``
28+
- ``SwiftViz/LinearScale/DoubleScale/transformAgainstDomain(_:)``
29+
30+
### Generating Ticks
31+
32+
- ``SwiftViz/LinearScale/DoubleScale/ticks(rangeLower:rangeHigher:)``
33+
- ``SwiftViz/LinearScale/DoubleScale/ticks(_:from:to:)``
34+
- ``SwiftViz/LinearScale/DoubleScale/labeledTickValues(_:from:to:)``
35+
- ``SwiftViz/LinearScale/DoubleScale/validatedTickLabels(_:from:to:)``
36+

‎Sources/SwiftViz/Documentation.docc/LinearScale_FloatScale.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``SwiftViz/LinearScale/FloatScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/LinearScale/FloatScale/init(from:to:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/LinearScale/FloatScale/domainLower``
12+
- ``SwiftViz/LinearScale/FloatScale/domainHigher``
13+
- ``SwiftViz/LinearScale/FloatScale/domainExtent``
14+
- ``SwiftViz/LinearScale/FloatScale/InputType``
15+
- ``SwiftViz/LinearScale/FloatScale/OutputType``
16+
- ``SwiftViz/LinearScale/FloatScale/transformType``
17+
- ``SwiftViz/DomainDataTransform``
18+
- ``SwiftViz/LinearScale/FloatScale/desiredTicks``
19+
20+
### Converting Values
21+
22+
- ``SwiftViz/LinearScale/FloatScale/scale(_:from:to:)``
23+
- ``SwiftViz/LinearScale/FloatScale/invert(_:from:to:)``
24+
25+
### Comparing Values
26+
27+
- ``SwiftViz/LinearScale/FloatScale/domainContains(_:)``
28+
- ``SwiftViz/LinearScale/FloatScale/transformAgainstDomain(_:)``
29+
30+
### Generating Ticks
31+
32+
- ``SwiftViz/LinearScale/FloatScale/ticks(rangeLower:rangeHigher:)``
33+
- ``SwiftViz/LinearScale/FloatScale/ticks(_:from:to:)``
34+
- ``SwiftViz/LinearScale/FloatScale/labeledTickValues(_:from:to:)``
35+
- ``SwiftViz/LinearScale/FloatScale/validatedTickLabels(_:from:to:)``
36+

‎Sources/SwiftViz/Documentation.docc/LinearScale_IntScale.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``SwiftViz/LinearScale/IntScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/LinearScale/IntScale/init(from:to:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/LinearScale/IntScale/domainLower``
12+
- ``SwiftViz/LinearScale/IntScale/domainHigher``
13+
- ``SwiftViz/LinearScale/IntScale/domainExtent``
14+
- ``SwiftViz/LinearScale/IntScale/InputType``
15+
- ``SwiftViz/LinearScale/IntScale/OutputType``
16+
- ``SwiftViz/LinearScale/IntScale/transformType``
17+
- ``SwiftViz/DomainDataTransform``
18+
- ``SwiftViz/LinearScale/IntScale/desiredTicks``
19+
20+
### Converting Values
21+
22+
- ``SwiftViz/LinearScale/IntScale/scale(_:from:to:)``
23+
- ``SwiftViz/LinearScale/IntScale/invert(_:from:to:)``
24+
25+
### Comparing Values
26+
27+
- ``SwiftViz/LinearScale/IntScale/domainContains(_:)``
28+
- ``SwiftViz/LinearScale/IntScale/transformAgainstDomain(_:)``
29+
30+
### Generating Ticks
31+
32+
- ``SwiftViz/LinearScale/IntScale/ticks(rangeLower:rangeHigher:)``
33+
- ``SwiftViz/LinearScale/IntScale/ticks(_:from:to:)``
34+
- ``SwiftViz/LinearScale/IntScale/labeledTickValues(_:from:to:)``
35+
- ``SwiftViz/LinearScale/IntScale/validatedTickLabels(_:from:to:)``
36+

‎Sources/SwiftViz/Documentation.docc/LogScale_DoubleScale.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``SwiftViz/LogScale/DoubleScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/LogScale/DoubleScale/init(from:to:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/LogScale/DoubleScale/domainLower``
12+
- ``SwiftViz/LogScale/DoubleScale/domainHigher``
13+
- ``SwiftViz/LogScale/DoubleScale/domainExtent``
14+
- ``SwiftViz/LogScale/DoubleScale/InputType``
15+
- ``SwiftViz/LogScale/DoubleScale/OutputType``
16+
- ``SwiftViz/LogScale/DoubleScale/transformType``
17+
- ``SwiftViz/DomainDataTransform``
18+
- ``SwiftViz/LogScale/DoubleScale/desiredTicks``
19+
20+
### Converting Values
21+
22+
- ``SwiftViz/LogScale/DoubleScale/scale(_:from:to:)``
23+
- ``SwiftViz/LogScale/DoubleScale/invert(_:from:to:)``
24+
25+
### Comparing Values
26+
27+
- ``SwiftViz/LogScale/DoubleScale/domainContains(_:)``
28+
- ``SwiftViz/LogScale/DoubleScale/transformAgainstDomain(_:)``
29+
30+
### Generating Ticks
31+
32+
- ``SwiftViz/LogScale/DoubleScale/ticks(rangeLower:rangeHigher:)``
33+
- ``SwiftViz/LogScale/DoubleScale/ticks(_:from:to:)``
34+
- ``SwiftViz/LogScale/DoubleScale/labeledTickValues(_:from:to:)``
35+
- ``SwiftViz/LogScale/DoubleScale/validatedTickLabels(_:from:to:)``
36+

‎Sources/SwiftViz/Documentation.docc/LogScale_FloatScale.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``SwiftViz/LogScale/FloatScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/LogScale/FloatScale/init(from:to:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/LogScale/FloatScale/domainLower``
12+
- ``SwiftViz/LogScale/FloatScale/domainHigher``
13+
- ``SwiftViz/LogScale/FloatScale/domainExtent``
14+
- ``SwiftViz/LogScale/FloatScale/InputType``
15+
- ``SwiftViz/LogScale/FloatScale/OutputType``
16+
- ``SwiftViz/LogScale/FloatScale/transformType``
17+
- ``SwiftViz/DomainDataTransform``
18+
- ``SwiftViz/LogScale/FloatScale/desiredTicks``
19+
20+
### Converting Values
21+
22+
- ``SwiftViz/LogScale/FloatScale/scale(_:from:to:)``
23+
- ``SwiftViz/LogScale/FloatScale/invert(_:from:to:)``
24+
25+
### Comparing Values
26+
27+
- ``SwiftViz/LogScale/FloatScale/domainContains(_:)``
28+
- ``SwiftViz/LogScale/FloatScale/transformAgainstDomain(_:)``
29+
30+
### Generating Ticks
31+
32+
- ``SwiftViz/LogScale/FloatScale/ticks(rangeLower:rangeHigher:)``
33+
- ``SwiftViz/LogScale/FloatScale/ticks(_:from:to:)``
34+
- ``SwiftViz/LogScale/FloatScale/labeledTickValues(_:from:to:)``
35+
- ``SwiftViz/LogScale/FloatScale/validatedTickLabels(_:from:to:)``
36+

‎Sources/SwiftViz/Documentation.docc/LogScale_IntScale.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ``SwiftViz/LogScale/IntScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/LogScale/IntScale/init(from:to:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/LogScale/IntScale/domainLower``
12+
- ``SwiftViz/LogScale/IntScale/domainHigher``
13+
- ``SwiftViz/LogScale/IntScale/domainExtent``
14+
- ``SwiftViz/LogScale/IntScale/InputType``
15+
- ``SwiftViz/LogScale/IntScale/OutputType``
16+
- ``SwiftViz/LogScale/IntScale/transformType``
17+
- ``SwiftViz/DomainDataTransform``
18+
- ``SwiftViz/LogScale/IntScale/desiredTicks``
19+
20+
### Converting Values
21+
22+
- ``SwiftViz/LogScale/IntScale/scale(_:from:to:)``
23+
- ``SwiftViz/LogScale/IntScale/invert(_:from:to:)``
24+
25+
### Comparing Values
26+
27+
- ``SwiftViz/LogScale/IntScale/domainContains(_:)``
28+
- ``SwiftViz/LogScale/IntScale/transformAgainstDomain(_:)``
29+
30+
### Generating Ticks
31+
32+
- ``SwiftViz/LogScale/IntScale/ticks(rangeLower:rangeHigher:)``
33+
- ``SwiftViz/LogScale/IntScale/ticks(_:from:to:)``
34+
- ``SwiftViz/LogScale/IntScale/labeledTickValues(_:from:to:)``
35+
- ``SwiftViz/LogScale/IntScale/validatedTickLabels(_:from:to:)``
36+

‎Sources/SwiftViz/Documentation.docc/PowerScale_DoubleScale.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# ``SwiftViz/PowerScale/DoubleScale``
2+
3+
## Topics
4+
5+
### Creating a Linear Scale
6+
7+
- ``SwiftViz/PowerScale/DoubleScale/init(from:to:exponent:transform:desiredTicks:)``
8+
9+
### Inspecting Scales
10+
11+
- ``SwiftViz/PowerScale/DoubleScale/domainLower``
12+
- ``SwiftViz/PowerScale/DoubleScale/domainHigher``
13+
- ``SwiftViz/PowerScale/DoubleScale/domainExtent``
14+
- ``SwiftViz/PowerScale/DoubleScale/exponent``
15+
- ``SwiftViz/PowerScale/DoubleScale/InputType``
16+
- ``SwiftViz/PowerScale/DoubleScale/OutputType``
17+
- ``SwiftViz/PowerScale/DoubleScale/transformType``
18+
- ``SwiftViz/DomainDataTransform``
19+
- ``SwiftViz/PowerScale/DoubleScale/desiredTicks``
20+
21+
### Converting Values
22+
23+
- ``SwiftViz/PowerScale/DoubleScale/scale(_:from:to:)``
24+
- ``SwiftViz/PowerScale/DoubleScale/invert(_:from:to:)``
25+
26+
### Comparing Values
27+
28+
- ``SwiftViz/PowerScale/DoubleScale/domainContains(_:)``
29+
- ``SwiftViz/PowerScale/DoubleScale/transformAgainstDomain(_:)``
30+
31+
### Generating Ticks
32+
33+
- ``SwiftViz/PowerScale/DoubleScale/ticks(rangeLower:rangeHigher:)``
34+
- ``SwiftViz/PowerScale/DoubleScale/ticks(_:from:to:)``
35+
- ``SwiftViz/PowerScale/DoubleScale/labeledTickValues(_:from:to:)``
36+
- ``SwiftViz/PowerScale/DoubleScale/validatedTickLabels(_:from:to:)``
37+

‎Sources/SwiftViz/Documentation.docc/Scale.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@
1414

1515
### Converting Values
1616

17-
- ``SwiftViz/Scale/invert(_:from:to:)``
1817
- ``SwiftViz/Scale/scale(_:from:to:)``
18+
- ``SwiftViz/Scale/scale(_:to:)``
19+
- ``SwiftViz/Scale/invert(_:from:to:)``
20+
- ``SwiftViz/Scale/invert(_:to:)``
1921

2022
### Comparing Values
2123

‎Sources/SwiftViz/NiceValue.swift‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import Numerics
1010

1111
/// A type that can be converted into an approximate value that is easier to understand.
1212
public protocol NiceValue {
13+
/// A type that can be converted into a nice number.
1314
associatedtype NumberType: Numeric, Comparable
1415
/// Returns a nice version of the number that's visually appealing for chart axis values.
1516
///

‎Sources/SwiftViz/Scale.swift‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ public enum DomainDataTransform {
4040

4141
/// A type that maps values from an input _domain_ to an output _range_.
4242
public protocol Scale {
43+
/// The type used for the scale's domain.
4344
associatedtype InputType: Numeric, Comparable, NiceValue
45+
/// The type used for the scale's range.
4446
associatedtype OutputType: Numeric, Comparable, NiceValue
4547

4648
/// A boolean value that indicates whether the output vales are constrained to the min and max of the output range.

0 commit comments

Comments
 (0)