You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,16 @@
2
2
3
3
## Introduction
4
4
5
-
Swift Numerics provides a set of modules that support numerical computing in Swift. These modules fall broadly into two categories:
5
+
Swift Numerics provides a set of modules that support numerical computing in Swift.
6
+
These modules fall broadly into two categories:
6
7
7
8
- API that is too specialized to go into the standard library, but which is sufficiently general to be centralized in a single common package.
8
9
- API that is under active development toward possible future inclusion in the standard library.
9
10
10
11
There is some overlap between these two categories, and an API that begins in the first category may migrate into the second as it matures and new uses are discovered.
11
12
12
-
Swift Numerics modules are fine-grained. For example, if you need support for Complex numbers, you can import ComplexModule¹ as a standalone module:
13
+
Swift Numerics modules are fine-grained.
14
+
For example, if you need support for Complex numbers, you can import ComplexModule¹ as a standalone module:
13
15
14
16
```swift
15
17
importComplexModule
@@ -29,7 +31,8 @@ Swift Numerics modules have minimal dependencies on other projects.
29
31
30
32
The current modules assume only the availability of the Swift and C standard libraries and the runtime support provided by compiler-rt.
31
33
32
-
Future expansion may assume the availability of other standard interfaces, such as [BLAS (Basic Linear Algebra Subprograms)](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms) and [LAPACK (Linear Algebra Package)](https://en.wikipedia.org/wiki/LAPACK). But modules with more specialized dependencies (or dependencies that are not available on all platforms supported by Swift) belong in a separate package.
34
+
Future expansion may assume the availability of other standard interfaces, such as [BLAS (Basic Linear Algebra Subprograms)](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms) and [LAPACK (Linear Algebra Package)](https://en.wikipedia.org/wiki/LAPACK).
35
+
But modules with more specialized dependencies (or dependencies that are not available on all platforms supported by Swift) belong in a separate package.
33
36
34
37
Because we intend to make it possible to adopt Swift Numerics modules in the standard library at some future point, Swift Numerics uses the same license and contribution guidelines as the Swift project.
35
38
@@ -56,7 +59,8 @@ To use Swift Numerics in a SwiftPM project:
56
59
57
60
## Contributing to Swift Numerics
58
61
59
-
Swift Numerics is a standalone library that is separate from the core Swift project. In practice, it will act as a staging ground for some APIs that may eventually be incorporated into the Swift Standard Library. When that happens, such changes will be proposed to the Swift Standard Library using the established evolution process of the Swift project.
62
+
Swift Numerics is a standalone library that is separate from the core Swift project, but it will sometimes act as a staging ground for APIs that will later be incorporated into the Swift Standard Library.
63
+
When that happens, such changes will be proposed to the Swift Standard Library using the established evolution process of the Swift project.
60
64
61
65
Swift Numerics uses GitHub issues to track bugs and features. We use pull requests for development.
62
66
@@ -84,8 +88,8 @@ Questions about how to use Swift Numerics modules, or issues that are not clearl
@@ -96,7 +100,8 @@ Questions about how to use Swift Numerics modules, or issues that are not clearl
96
100
97
101
## Notes
98
102
99
-
¹ Swift is currently unable to use the fully-qualified name for types when a type and module have the same name (discussion here: https://forums.swift.org/t/pitch-fully-qualified-name-syntax/28482). This would prevent users of Swift Numerics who don't need generic types from doing things, such as:
103
+
¹ Swift is currently unable to use the fully-qualified name for types when a type and module have the same name (discussion here: https://forums.swift.org/t/pitch-fully-qualified-name-syntax/28482).
104
+
This would prevent users of Swift Numerics who don't need generic types from doing things, such as:
The `Real` module does not contain a `Real` type, but does contain a `Real` protocol, and users may want to define their own `Real` type (and possibly re-export the `Real` module) - that is why the suffix is also applied there. New modules have to evaluate this decision carefully, but can err on the side of adding the suffix. It's expected that most users will simply `import Numerics`, so this isn't an issue for them.
122
+
The `Real` module does not contain a `Real` type, but does contain a `Real` protocol.
123
+
Users may want to define their own `Real` type (and possibly re-export the `Real` module)--that is why the suffix is also applied there.
124
+
New modules have to evaluate this decision carefully, but can err on the side of adding the suffix.
125
+
It's expected that most users will simply `import Numerics`, so this isn't an issue for them.
0 commit comments