internal/asm/...: add documentation

This documentation is intended to allow gonum developers to see exactly
what an asm function is intended to do. They are not for external code
consumers.
This commit is contained in:
kortschak
2017-04-22 17:21:47 +09:30
parent 54ff12b7ee
commit af58b714c9
24 changed files with 533 additions and 12 deletions

View File

@@ -4,18 +4,32 @@
package c128
// ScalUnitary is
// for i := range x {
// x[i] *= alpha
// }
func ScalUnitary(alpha complex128, x []complex128) {
for i := range x {
x[i] *= alpha
}
}
// ScalUnitaryTo is
// for i, v := range x {
// dst[i] = alpha * v
// }
func ScalUnitaryTo(dst []complex128, alpha complex128, x []complex128) {
for i, v := range x {
dst[i] = alpha * v
}
}
// ScalInc is
// var ix uintptr
// for i := 0; i < int(n); i++ {
// x[ix] *= alpha
// ix += incX
// }
func ScalInc(alpha complex128, x []complex128, n, incX uintptr) {
var ix uintptr
for i := 0; i < int(n); i++ {
@@ -24,6 +38,13 @@ func ScalInc(alpha complex128, x []complex128, n, incX uintptr) {
}
}
// ScalIncTo is
// var idst, ix uintptr
// for i := 0; i < int(n); i++ {
// dst[idst] = alpha * x[ix]
// ix += incX
// idst += incDst
// }
func ScalIncTo(dst []complex128, incDst uintptr, alpha complex128, x []complex128, n, incX uintptr) {
var idst, ix uintptr
for i := 0; i < int(n); i++ {