Skip to content

Point to getindex_value in AbstractFill docstring #323

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 13, 2024
Merged

Point to getindex_value in AbstractFill docstring #323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1dcf01
Point to getindex_value in AbstractFill docstring
jishnub Dec 5, 2023
10a00ca
Update phrasing
jishnub Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/FillArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ import Base: oneto
"""
AbstractFill{T, N, Axes} <: AbstractArray{T, N}

Supertype for lazy array types whose entries are all equal to constant.
Supertype for lazy array types whose entries are all equal.
Subtypes of `AbstractFill` should implement [`FillArrays.getindex_value`](@ref) to return the value of the entries.
"""
abstract type AbstractFill{T, N, Axes} <: AbstractArray{T, N} end
const AbstractFillVector{T} = AbstractFill{T,1}
Expand Down Expand Up @@ -145,7 +146,7 @@ Fill{T,0}(x, ::Tuple{}) where T = Fill{T,0,Tuple{}}(convert(T, x)::T, ()) # ambi
@inline size(F::Fill) = map(length, F.axes)

"""
getindex_value(F::AbstractFill)
FillArrays.getindex_value(F::AbstractFill)

Return the value that `F` is filled with.

Expand Down