sscal

package

v0.2.0 Latest Latest Go to latest Published: Aug 27, 2022 License: BSD-3-Clause Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wirehaiku/SSCal

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AssertOp(t *testing.T, s string, st *Stack, fs ...float64)
func Eval(a any, st *Stack) error
func EvalAll(as []any, st *Stack) error
func Input() (string, error)
func Main()
func Output(s string, as ...any)
func Parse(s string) (any, error)
func ParseAll(s string) ([]any, error)
func Prompt(s string) (string, error)
type OperFunc
type Operator
- func (op *Operator) Run(st *Stack) error
type Stack
- func NewStack(fs ...float64) *Stack

Constants ¶

View Source

const VersionDate = "2022-08-27"

VersionDate is SSCal's current version date.

View Source

const VersionNumber = "0.2.0"

VersionNumber is SSCal's current version number.

Variables ¶

View Source

var Banner = fmt.Sprintf("SSCal version %s (%s).", VersionNumber, VersionDate)

Banner is SSCal's interactive banner string.

View Source

var Operators = map[string]*Operator{

	"-": Op2(func(a, b float64) float64 { return a - b }),
	"*": Op2(func(a, b float64) float64 { return a * b }),
	"/": Op2(func(a, b float64) float64 { return a / b }),
	"+": Op2(func(a, b float64) float64 { return a + b }),

	"ceil":  Op1(math.Ceil),
	"floor": Op1(math.Floor),
	"sqrt":  Op1(math.Sqrt),

	"%":   Op2(math.Mod),
	"**":  Op2(math.Pow),
	"max": Op2(math.Max),
	"min": Op2(math.Min),

	"dupe": NewOperator(1, func(st *Stack) error {
		st.Push(st.Peek())
		return nil
	}),

	"swap": NewOperator(2, func(st *Stack) error {
		a, b := st.Pop(), st.Pop()
		st.Push(a)
		st.Push(b)
		return nil
	}),
}

Operators is a map of all available Operators.

View Source

var Reader = bufio.NewReader(os.Stdin)

Reader is SSCal's default standard input Reader.

View Source

var Writer = bufio.NewWriter(os.Stdout)

Writer is SSCal's default standard input Writer.

Functions ¶

func AssertOp ¶

func AssertOp(t *testing.T, s string, st *Stack, fs ...float64)

AssertOp asserts the results of an Operator.

func Eval ¶

func Eval(a any, st *Stack) error

Eval evaluates one float or Operator against a Stack.

func EvalAll ¶

func EvalAll(as []any, st *Stack) error

EvalAll evaluates a slice of floats and Operators against a Stack.

func Input ¶

func Input() (string, error)

Input returns a trimmed input string.

func Main ¶

func Main()

Main runs the main SSCal program.

func Output ¶

func Output(s string, as ...any)

Output writes a formatted output string.

func Parse ¶

func Parse(s string) (any, error)

Parse returns a float or Operator from a string.

func ParseAll ¶

func ParseAll(s string) ([]any, error)

ParseAll returns a slice of floats and Operators from a string.

func Prompt ¶

func Prompt(s string) (string, error)

Prompt writes a padded prompt string and returns an input string.

Types ¶

type OperFunc ¶

type OperFunc func(*Stack) error

OperFunc is a function that operates on a Stack.

type Operator ¶

type Operator struct {
	// Size is the minimum Stack size the Operator needs.
	Size int

	// Func is the Operator's callable function.
	Func OperFunc
}

Operator is a callable Stack operator.

func NewOperator ¶

func NewOperator(i int, fn OperFunc) *Operator

NewOperator returns a pointer to a new Operator.

func Op1 ¶

func Op1(fn func(float64) float64) *Operator

Op1 returns an Operator from a function that takes one float argument.

func Op2 ¶

func Op2(fn func(float64, float64) float64) *Operator

Op2 returns an Operator from a function that takes two float arguments.

func (*Operator) Run ¶

func (op *Operator) Run(st *Stack) error

Run applies the Operator's callable function to a Stack.

type Stack ¶

type Stack struct {
	Floats []float64
}

Stack is a last-in-first-out stack of floats.

func NewStack ¶

func NewStack(fs ...float64) *Stack

NewStack returns a pointer to a new Stack.

func (*Stack) Empty ¶

func (st *Stack) Empty() bool

Empty returns true if the Stack has no floats.

func (*Stack) End ¶

func (st *Stack) End() int

End returns the index of the top float on the Stack.

func (*Stack) Len ¶

func (st *Stack) Len() int

Len returns the number of floats on the Stack.

func (*Stack) Peek ¶

func (st *Stack) Peek() float64

Peek returns the top float on the Stack,

func (*Stack) Pop ¶

func (st *Stack) Pop() float64

Pop removes and returns the top float on the Stack.

func (*Stack) Push ¶

func (st *Stack) Push(f float64)

Push appends a float to the top of the Stack.

func (*Stack) String ¶

func (st *Stack) String() string

String returns the Stack as a space-separated string.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL