-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add documentation for [Abstract]Vector/[Abstract]Matrix #22674
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,8 +3,20 @@ | |
## array.jl: Dense arrays | ||
|
||
## Type aliases for convenience ## | ||
""" | ||
AbstractVector{T} | ||
|
||
Abstract vector supertype containing elements of type `T`. | ||
Alias for [`AbstractArray{T,1}`](@ref). | ||
""" | ||
const AbstractVector{T} = AbstractArray{T,1} | ||
|
||
""" | ||
AbstractMatrix{T} | ||
|
||
Abstract matrix supertype containing elements of type `T`. | ||
Alias for [`AbstractArray{T,2}`](@ref). | ||
""" | ||
const AbstractMatrix{T} = AbstractArray{T,2} | ||
const AbstractVecOrMat{T} = Union{AbstractVector{T}, AbstractMatrix{T}} | ||
const RangeIndex = Union{Int, Range{Int}, AbstractUnitRange{Int}} | ||
|
@@ -13,7 +25,18 @@ const IntOrInd = Union{Int, AbstractUnitRange} | |
const DimsOrInds{N} = NTuple{N,DimOrInd} | ||
const NeedsShaping = Union{Tuple{Integer,Vararg{Integer}}, Tuple{OneTo,Vararg{OneTo}}} | ||
|
||
""" | ||
Vector{T} | ||
|
||
Vector type containing elements of type `T`. Alias for [`Array{T,1}`](@ref). | ||
""" | ||
const Vector{T} = Array{T,1} | ||
|
||
""" | ||
Matrix{T} | ||
|
||
Matrix type containing elements of type `T`. Alias for [`Array{T,2}`](@ref). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These descriptions of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yea that's better. |
||
""" | ||
const Matrix{T} = Array{T,2} | ||
const VecOrMat{T} = Union{Vector{T}, Matrix{T}} | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps
Range
should also get aref
? (Int
is probably fine without one.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Range
does not have a docstring, so leaving that one out.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, didn't realize. That's too bad.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps documenting
Range
deserves an intro issue?