add docs for BLAS.iamax (#31277)

JuliaLang · Mar 11, 2019 · 38439d9 · 38439d9
1 parent d2a54ca
commit 38439d9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/stdlib/LinearAlgebra/docs/src/index.md b/stdlib/LinearAlgebra/docs/src/index.md
@@ -501,6 +501,7 @@ LinearAlgebra.BLAS.asum
 LinearAlgebra.axpy!
 LinearAlgebra.BLAS.scal!
 LinearAlgebra.BLAS.scal
+LinearAlgebra.BLAS.iamax
 LinearAlgebra.BLAS.ger!
 LinearAlgebra.BLAS.syr!
 LinearAlgebra.BLAS.syrk!

diff --git a/stdlib/LinearAlgebra/src/blas.jl b/stdlib/LinearAlgebra/src/blas.jl
@@ -548,6 +548,15 @@ for (fname, elty) in ((:idamax_,:Float64),
 end
 iamax(dx::Union{AbstractVector,DenseArray}) = GC.@preserve dx iamax(length(dx), pointer(dx), stride1(dx))
 
+"""
+    iamax(n, dx, incx)
+    iamax(dx)
+
+Find the index of the element of `dx` with the maximum absolute value. `n` is the length of `dx`, and `incx` is the
+stride. If `n` and `incx` are not provided, they assume default values of `n=length(dx)` and `incx=stride1(dx)`.
+"""
+iamax
+
 # Level 2
 ## mv
 ### gemv