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
docs: Clarify important points about parametric types
ClosesJuliaLang#43811.
- The intro section felt a bit long-winded, I've made some changes there first.
- Clarify that `typeof` returns the concrete type
- Rename Type Declarations section to Type Annotations,
avoid confusion with Declaring Types section and distinguish use of "type declaration"
to mean "declaring new types"
- Removed some of the jargon and wikipedia links to make room for
a brief alternative `Point{T1,T2}` demonstration.
- Shifted some paragraphs around to reflect their importance,
and changed the wording in some places.
- Rename type declaration -> annotation in other places (docstrings/comments)
Copy file name to clipboardexpand all lines: doc/src/index.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -64,13 +64,13 @@ The most significant departures of Julia from typical dynamic languages are:
64
64
* The core language imposes very little; Julia Base and the standard library are written in Julia itself, including
65
65
primitive operations like integer arithmetic
66
66
* A rich language of types for constructing and describing objects, that can also optionally be
67
-
used to make type declarations
67
+
used to write type annotations
68
68
* The ability to define function behavior across many combinations of argument types via [multiple dispatch](https://en.wikipedia.org/wiki/Multiple_dispatch)
69
69
* Automatic generation of efficient, specialized code for different argument types
70
70
* Good performance, approaching that of statically-compiled languages like C
71
71
72
72
Although one sometimes speaks of dynamic languages as being "typeless", they are definitely not:
73
-
every object, whether primitive or user-defined, has a type. The lack of type declarations in
73
+
every object, whether primitive or user-defined, has a type. The lack of type annotations in
74
74
most dynamic languages, however, means that one cannot instruct the compiler about the types of
75
75
values, and often cannot explicitly talk about types at all. In static languages, on the other
76
76
hand, while one can -- and usually must -- annotate types for the compiler, types exist only at
and the `::Integer` specification means that it will only be callable when `n` is a subtype of the [abstract](@ref man-abstract-types) `Integer` type.
74
74
75
-
Argument-type declarations**normally have no impact on performance**: regardless of what argument types (if any) are declared, Julia compiles a specialized version of the function for the actual argument types passed by the caller. For example, calling `fib(1)` will trigger the compilation of specialized version of `fib` optimized specifically for `Int` arguments, which is then re-used if `fib(7)` or `fib(15)` are called. (There are rare exceptions when an argument-type declaration can trigger additional compiler specializations; see: [Be aware of when Julia avoids specializing](@ref).) The most common reasons to declare argument types in Julia are, instead:
75
+
Argument-type annotations**normally have no impact on performance**: regardless of what argument types (if any) are declared, Julia compiles a specialized version of the function for the actual argument types passed by the caller. For example, calling `fib(1)` will trigger the compilation of specialized version of `fib` optimized specifically for `Int` arguments, which is then re-used if `fib(7)` or `fib(15)` are called. (There are rare exceptions when an argument-type annotation can trigger additional compiler specializations; see: [Be aware of when Julia avoids specializing](@ref).) The most common reasons to declare argument types in Julia are, instead:
76
76
77
77
***Dispatch:** As explained in [Methods](@ref), you can have different versions ("methods") of a function for different argument types, in which case the argument types are used to determine which implementation is called for which arguments. For example, you might implement a completely different algorithm `fib(x::Number) = ...` that works for any `Number` type by using [Binet's formula](https://en.wikipedia.org/wiki/Fibonacci_number#Binet%27s_formula) to extend it to non-integer values.
78
-
***Correctness:** Type declarations can be useful if your function only returns correct results for certain argument types. For example, if we omitted argument types and wrote `fib(n) = n ≤ 2 ? one(n) : fib(n-1) + fib(n-2)`, then `fib(1.5)` would silently give us the nonsensical answer `1.0`.
79
-
***Clarity:** Type declarations can serve as a form of documentation about the expected arguments.
78
+
***Correctness:** Type annotations can be useful if your function only returns correct results for certain argument types. For example, if we omitted argument types and wrote `fib(n) = n ≤ 2 ? one(n) : fib(n-1) + fib(n-2)`, then `fib(1.5)` would silently give us the nonsensical answer `1.0`.
79
+
***Clarity:** Type annotations can serve as a form of documentation about the expected arguments.
80
80
81
81
However, it is a **common mistake to overly restrict the argument types**, which can unnecessarily limit the applicability of the function and prevent it from being re-used in circumstances you did not anticipate. For example, the `fib(n::Integer)` function above works equally well for `Int` arguments (machine integers) and `BigInt` arbitrary-precision integers (see [BigFloats and BigInts](@ref BigFloats-and-BigInts)), which is especially useful because Fibonacci numbers grow exponentially rapidly and will quickly overflow any fixed-precision type like `Int` (see [Overflow behavior](@ref)). If we had declared our function as `fib(n::Int)`, however, the application to `BigInt` would have been prevented for no reason. In general, you should use the most general applicable abstract types for arguments, and **when in doubt, omit the argument types**. You can always add argument-type specifications later if they become necessary, and you don't sacrifice performance or functionality by omitting them.
82
82
@@ -161,9 +161,9 @@ Int8
161
161
```
162
162
163
163
This function will always return an `Int8` regardless of the types of `x` and `y`.
164
-
See [Type Declarations](@ref) for more on return types.
164
+
See [Type Annotations](@ref) for more on return types.
165
165
166
-
Return type declarations are **rarely used** in Julia: in general, you should
166
+
Return type annotations are **rarely used** in Julia: in general, you should
167
167
instead write "type-stable" functions in which Julia's compiler can automatically
168
168
infer the return type. For more information, see the [Performance Tips](@ref man-performance-tips) chapter.
0 commit comments