Skip to content

Commit fa4c75f

Browse files
authored
docs: move terms and definitions to separate document
PR-URL: #941
1 parent f59d9f1 commit fa4c75f

File tree

3 files changed

+60
-42
lines changed

3 files changed

+60
-42
lines changed

spec/draft/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Contents
99
:maxdepth: 1
1010

1111
purpose_and_scope
12+
terms_and_definitions
1213
use_cases
1314
assumptions
1415

spec/draft/purpose_and_scope.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -418,48 +418,6 @@ completed such an implementation may, and are encouraged to, provide details on
418418
the level of (non-)conformance. For details on how to do this, see
419419
[Verification - measuring conformance](verification_test_suite.md).
420420

421-
422-
* * *
423-
424-
## Terms and Definitions
425-
426-
For the purposes of this specification, the following terms and definitions apply.
427-
428-
<!-- NOTE: please keep terms in alphabetical order -->
429-
430-
**array**:
431-
a (usually fixed-size) multidimensional container of items of the same type and size.
432-
433-
**axis**:
434-
an array dimension.
435-
436-
**branch cut**:
437-
a curve in the complex plane across which a given complex function fails to be continuous.
438-
439-
**broadcast**:
440-
automatic (implicit) expansion of array dimensions to be of equal sizes without copying array data for the purpose of making arrays with different shapes have compatible shapes for element-wise operations.
441-
442-
**compatible**:
443-
two arrays whose dimensions are compatible (i.e., where the size of each dimension in one array is either equal to one or to the size of the corresponding dimension in a second array).
444-
445-
**element-wise**:
446-
an operation performed element-by-element, in which individual array elements are considered in isolation and independently of other elements within the same array.
447-
448-
**matrix**:
449-
a two-dimensional array.
450-
451-
**rank**:
452-
number of array dimensions (not to be confused with the number of linearly independent columns of a matrix).
453-
454-
**shape**:
455-
a tuple of `N` non-negative integers that specify the sizes of each dimension and where `N` corresponds to the number of dimensions.
456-
457-
**singleton dimension**:
458-
a dimension whose size is one.
459-
460-
**vector**:
461-
a one-dimensional array.
462-
463421
* * *
464422

465423
## Normative References

spec/draft/terms_and_definitions.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Terms and Definitions
2+
3+
For the purposes of this specification, the following terms and definitions apply.
4+
5+
## Normative Keywords
6+
7+
This specification aims to follow [RFC 2119](https://tools.ietf.org/html/rfc2119) and use the following keywords to indicate requirement levels:
8+
9+
**must**:
10+
a definition or behavior is an absolute requirement of this specification.
11+
12+
**must not**:
13+
a definition or behavior is an absolute prohibition of this specification.
14+
15+
**should**:
16+
valid reasons may exist to ignore a definition or behavior in particular circumstances; however, the full implications must be understood and carefully weighed before choosing a different course.
17+
18+
**should not**:
19+
valid reasons may exist when a particular discouraged behavior is acceptable or even useful; however, the full implications must be understood and carefully weighed before implementing any behavior described by this keyword.
20+
21+
**may**:
22+
a definition or behavior is truly optional.
23+
24+
## General Terminology
25+
26+
<!-- NOTE: please keep terms in alphabetical order -->
27+
28+
**array**:
29+
a (usually fixed-size) multidimensional container of items of the same type and size.
30+
31+
**axis**:
32+
an array dimension.
33+
34+
**branch cut**:
35+
a curve in the complex plane across which a given complex function fails to be continuous.
36+
37+
**broadcast**:
38+
automatic (implicit) expansion of array dimensions to be of equal sizes without copying array data for the purpose of making arrays with different shapes have compatible shapes for element-wise operations.
39+
40+
**compatible**:
41+
two arrays whose dimensions are compatible (i.e., where the size of each dimension in one array is either equal to one or to the size of the corresponding dimension in a second array).
42+
43+
**element-wise**:
44+
an operation performed element-by-element, in which individual array elements are considered in isolation and independently of other elements within the same array.
45+
46+
**matrix**:
47+
a two-dimensional array.
48+
49+
**rank**:
50+
number of array dimensions (not to be confused with the number of linearly independent columns of a matrix).
51+
52+
**shape**:
53+
a tuple of `N` non-negative integers that specify the sizes of each dimension and where `N` corresponds to the number of dimensions.
54+
55+
**singleton dimension**:
56+
a dimension whose size is one.
57+
58+
**vector**:
59+
a one-dimensional array.

0 commit comments

Comments
 (0)