axisds

type Boundary ¶

type Boundary any

Boundary is the most basic unit used by this library. It represents a boundary on a 1D axis.

The data structures in this package operate on half-open intervals like [startBoundary, endBoundary).

Endpoint is a Boundary wrapper that creates more fine-grained intervals, allowing arbitrary types of intervals (in terms of inclusive vs exclusive endpoints).

NOTE: it's equivalent to think of Boundaries as being infinitesimal and not corresponding to any valid value. In this case, there is no concept of inclusive or exclusive intervals. Endpoint can represent infinitesimal boundaries that are immediately before or after a value, allowing arbitrary types of intervals (with respect to valid values).

type BoundaryFormatter ¶

type BoundaryFormatter[B Boundary] func(b B) string

BoundaryFormatter is used to print boundaries.

func MakeBoundaryFormatter[B Boundary]() BoundaryFormatter[B]

type CompareFn ¶

type CompareFn[B Boundary] func(x, y B) int

CompareFn is a function that compares two boundaries and returns -1, 0, or +1.

func EndpointCompareFn[B Boundary](bCmp CompareFn[B]) CompareFn[Endpoint[B]]

type Endpoint ¶

type Endpoint[B Boundary] struct {
	B B
	// If PlusEpsilon is true, the boundary is considered to be infinitesimally
	// after B. When used as an interval ending point, it corresponds to an
	// inclusive end bound. When used as an interval starting point, it
	// corresponds to an exclusive start bound.
	PlusEpsilon bool
}

Endpoint is a Boundary that extends a simpler boundary type to allow representing intervals with inclusive or exclusive end points.

func MakeEndEndpoint[B Boundary](endBoundary B, endTyp InclusiveOrExclusive) Endpoint[B]

func MakeEndpoints[B Boundary](
	startBoundary B, startTyp InclusiveOrExclusive, endBoundary B, endTyp InclusiveOrExclusive,
) (start, end Endpoint[B])

func MakeStartEndpoint[B Boundary](startBoundary B, startTyp InclusiveOrExclusive) Endpoint[B]

type InclusiveOrExclusive ¶

type InclusiveOrExclusive int8

InclusiveOrExclusive is used to specify the type of interval endpoint.

const Exclusive InclusiveOrExclusive = 2

const Inclusive InclusiveOrExclusive = 1

func InclusiveIf(inclusive bool) InclusiveOrExclusive

type Interval ¶

type Interval[B Boundary] struct {
	Start, End B
}

Interval represents the half-open interval [Start, End). See Boundary and Endpoint for more details.

type IntervalFormatter ¶

type IntervalFormatter[B Boundary] func(i Interval[B]) string

IntervalFormatter is used to print intervals.

func MakeEndpointIntervalFormatter[B Boundary](
	bFmt BoundaryFormatter[B],
) IntervalFormatter[Endpoint[B]]

func MakeIntervalFormatter[B Boundary](bFmt BoundaryFormatter[B]) IntervalFormatter[B]

type Parser ¶

type Parser[B Boundary] interface {
	// ParseBoundary is used to parse a "bare" boundary. Used for Endpoint[B].
	ParseBoundary(str string) (b B, err error)

	// ParseInterval parses an interval of the form `boundary1, boundary2`
	// from the input and returns any remaining fields in the string.
	ParseInterval(input string) (start, end B, remaining string, err error)
}

Parser is an interface for parsing intervals.

func MakeBasicParser[B Boundary]() Parser[B]

func MakeEndpointParser[B Boundary](p Parser[B]) Parser[Endpoint[B]]