code/avo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

support docstrings

Browse Source
This commit is contained in:
Michael McLoughlin
2018-12-27 23:01:27 -08:00
parent 023324a4ec
commit 9f5277bf8e
6 changed files with 38 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
examples/returns/asm.go
View File

@@ -10,8 +10,11 @@ import (
func main() {
Package("github.com/mmcloughlin/avo/examples/returns")
// Multiple unnamed return values.
TEXT("Interval", "func(start, size uint64) (uint64, uint64)")
Doc(
"Interval returns the (start, end) of an interval with the given start and size.",
"Demonstrates multiple unnamed return values.",
)
start := Load(Param("start"), GP64v())
size := Load(Param("size"), GP64v())
end := size
@@ -20,8 +23,11 @@ func main() {
Store(end, ReturnIndex(1))
RET()
// Butterfly demonstrates multiple named return values.
TEXT("Butterfly", "func(x0, x1 float64) (y0, y1 float64)")
Doc(
"Butterfly performs a 2-dimensional butterfly operation: computes (x0+x1, x0-x1).",
"Demonstrates multiple named return values.",
)
x0 := Load(Param("x0"), Xv())
x1 := Load(Param("x1"), Xv())
y0, y1 := Xv(), Xv()
@@ -33,16 +39,22 @@ func main() {
Store(y1, Return("y1"))
RET()
// Septuple returns an array of seven of the given byte.
TEXT("Septuple", "func(byte) [7]byte")
Doc(
"Septuple returns an array of seven of the given byte.",
"Demonstrates returning array values.",
)
b := Load(ParamIndex(0), GP8v())
for i := 0; i < 7; i++ {
Store(b, ReturnIndex(0).Index(i))
}
RET()
// CriticalLine returns the complex value 0.5 + it on Riemann's critical line.
TEXT("CriticalLine", "func(t float64) complex128")
Doc(
"CriticalLine returns the complex value 0.5 + it on Riemann's critical line.",
"Demonstrates returning complex values.",
)
t := Load(Param("t"), Xv())
half := Xv()
MOVSD(ConstData("half", F64(0.5)), half)
@@ -50,8 +62,11 @@ func main() {
Store(t, ReturnIndex(0).Imag())
RET()
// NewStruct initializes a Struct value.
TEXT("NewStruct", "func(w uint16, p [2]float64, q uint64) Struct")
Doc(
"NewStruct initializes a Struct value.",
"Demonstrates returning struct values.",
)
w := Load(Param("w"), GP16v())
x := Load(Param("p").Index(0), Xv())
y := Load(Param("p").Index(1), Xv())

10
examples/returns/stub.go
View File

@@ -2,12 +2,22 @@
package returns
// Interval returns the (start, end) of an interval with the given start and size.
// Demonstrates multiple unnamed return values.
func Interval(start uint64, size uint64) (uint64, uint64)
// Butterfly performs a 2-dimensional butterfly operation: computes (x0+x1, x0-x1).
// Demonstrates multiple named return values.
func Butterfly(x0 float64, x1 float64) (y0 float64, y1 float64)
// Septuple returns an array of seven of the given byte.
// Demonstrates returning array values.
func Septuple(byte) [7]byte
// CriticalLine returns the complex value 0.5 + it on Riemann's critical line.
// Demonstrates returning complex values.
func CriticalLine(t float64) complex128
// NewStruct initializes a Struct value.
// Demonstrates returning struct values.
func NewStruct(w uint16, p [2]float64, q uint64) Struct