Documentation
¶
Overview ¶
Package "elements" provides a framework of aspects and class definitions for a rich set of primitive data types that are elemental. All primitive types are immutable and—for better performance—are implemented as extensions to existing Go primitive types.
For detailed documentation on this package refer to the wiki:
This package follows the Crater Dog Technologies™ Go Coding Conventions located here:
Additional concrete implementations of the classes declared by this package can be developed and used seamlessly since the interface declarations only depend on other interfaces and intrinsic types—and the class implementations only depend on interfaces, not on each other.
Index ¶
- type AngleClassLike
- type AngleLike
- type BooleanClassLike
- type BooleanLike
- type Continuous
- type Discrete
- type DurationClassLike
- type DurationLike
- type Factored
- type GlyphClassLike
- type GlyphLike
- type MomentClassLike
- type MomentLike
- type NumberClassLike
- type NumberLike
- type PercentageClassLike
- type PercentageLike
- type Polarized
- type ProbabilityClassLike
- type ProbabilityLike
- type ResourceClassLike
- type ResourceLike
- type SymbolClassLike
- type SymbolLike
- type Temporal
- type Units
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AngleClassLike ¶
type AngleClassLike interface {
// Constructor Methods
Angle(
radians float64,
) AngleLike
AngleFromSource(
source string,
) AngleLike
// Constant Methods
Undefined() AngleLike
Zero() AngleLike
Pi() AngleLike
Tau() AngleLike
// Function Methods
Inverse(
angle AngleLike,
) AngleLike
Sum(
first AngleLike,
second AngleLike,
) AngleLike
Difference(
first AngleLike,
second AngleLike,
) AngleLike
Scaled(
angle AngleLike,
factor float64,
) AngleLike
Complement(
angle AngleLike,
) AngleLike
Supplement(
angle AngleLike,
) AngleLike
Conjugate(
angle AngleLike,
) AngleLike
Cosine(
angle AngleLike,
) float64
ArcCosine(
x float64,
) AngleLike
Sine(
angle AngleLike,
) float64
ArcSine(
y float64,
) AngleLike
Tangent(
angle AngleLike,
) float64
ArcTangent(
x float64,
y float64,
) AngleLike
}
AngleClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each angle-like concrete class.
func AngleClass ¶
func AngleClass() AngleClassLike
type AngleLike ¶
type AngleLike interface {
// Principal Methods
GetClass() AngleClassLike
AsIntrinsic() float64
AsSource() string
AsUnits(
units Units,
) float64
AsParts() (
x float64,
y float64,
)
// Aspect Interfaces
Continuous
}
AngleLike is an instance interface that declares the complete set of principal, attribute and aspect methods that must be supported by each instance of a concrete angle-like class.
type BooleanClassLike ¶
type BooleanClassLike interface {
// Constructor Methods
Boolean(
boolean bool,
) BooleanLike
BooleanFromSource(
source string,
) BooleanLike
// Constant Methods
False() BooleanLike
True() BooleanLike
// Function Methods
Not(
boolean BooleanLike,
) BooleanLike
And(
first BooleanLike,
second BooleanLike,
) BooleanLike
San(
first BooleanLike,
second BooleanLike,
) BooleanLike
Ior(
first BooleanLike,
second BooleanLike,
) BooleanLike
Xor(
first BooleanLike,
second BooleanLike,
) BooleanLike
}
BooleanClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each boolean-like concrete class.
func BooleanClass ¶
func BooleanClass() BooleanClassLike
type BooleanLike ¶
type BooleanLike interface {
// Principal Methods
GetClass() BooleanClassLike
AsIntrinsic() bool
AsSource() string
// Aspect Interfaces
Discrete
}
BooleanLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a boolean-like class.
type Continuous ¶
type Continuous interface {
AsFloat() float64
AsSource() string
HasMagnitude() bool
IsInfinite() bool
IsDefined() bool
IsMinimum() bool
IsZero() bool
IsMaximum() bool
}
Continuous is an aspect interface that defines a set of method signatures that must be supported by each instance of a continuous class.
type Discrete ¶
type Discrete interface {
AsInteger() int
AsSource() string
IsDefined() bool
IsMinimum() bool
IsZero() bool
IsMaximum() bool
}
Discrete is an aspect interface that defines a set of method signatures that must be supported by each instance of a discrete class.
type DurationClassLike ¶
type DurationClassLike interface {
// Constructor Methods
Duration(
milliseconds int,
) DurationLike
DurationFromSource(
source string,
) DurationLike
// Constant Methods
MillisecondsPerSecond() uint
MillisecondsPerMinute() uint
MillisecondsPerHour() uint
MillisecondsPerDay() uint
MillisecondsPerWeek() uint
MillisecondsPerMonth() uint
MillisecondsPerYear() uint
DaysPerMonth() float64
DaysPerYear() float64
WeeksPerMonth() float64
}
DurationClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each duration-like concrete class.
func DurationClass ¶
func DurationClass() DurationClassLike
type DurationLike ¶
type DurationLike interface {
// Principal Methods
GetClass() DurationClassLike
AsIntrinsic() uint
AsSource() string
// Aspect Interfaces
Discrete
Factored
Temporal
}
DurationLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a duration-like class.
type Factored ¶
type Factored interface {
GetMilliseconds() uint
GetSeconds() uint
GetMinutes() uint
GetHours() uint
GetDays() uint
GetWeeks() uint
GetMonths() uint
GetYears() uint
}
Factored is an aspect interface that defines a set of method signatures that must be supported by each instance of a factored class.
type GlyphClassLike ¶
type GlyphClassLike interface {
// Constructor Methods
Glyph(
rune_ rune,
) GlyphLike
GlyphFromInteger(
integer int,
) GlyphLike
GlyphFromSource(
source string,
) GlyphLike
// Constant Methods
Undefined() GlyphLike
// Function Methods
ToLowercase(
glyph GlyphLike,
) GlyphLike
ToUppercase(
glyph GlyphLike,
) GlyphLike
}
GlyphClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each glyph-like concrete class.
func GlyphClass ¶
func GlyphClass() GlyphClassLike
type GlyphLike ¶
type GlyphLike interface {
// Principal Methods
GetClass() GlyphClassLike
AsIntrinsic() rune
AsSource() string
// Aspect Interfaces
Discrete
}
GlyphLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a glyph-like class.
type MomentClassLike ¶
type MomentClassLike interface {
// Constructor Methods
Moment(
milliseconds int,
) MomentLike
MomentFromSource(
source string,
) MomentLike
// Constant Methods
Epoch() MomentLike
// Function Methods
Now() MomentLike
Earlier(
moment MomentLike,
duration DurationLike,
) MomentLike
Later(
moment MomentLike,
duration DurationLike,
) MomentLike
Duration(
first MomentLike,
second MomentLike,
) DurationLike
}
MomentClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each moment-like concrete class.
func MomentClass ¶
func MomentClass() MomentClassLike
type MomentLike ¶
type MomentLike interface {
// Principal Methods
GetClass() MomentClassLike
AsIntrinsic() int
AsSource() string
// Aspect Interfaces
Discrete
Factored
Polarized
Temporal
}
MomentLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a moment-like class.
type NumberClassLike ¶
type NumberClassLike interface {
// Constructor Methods
Number(
complex_ complex128,
) NumberLike
NumberFromPolar(
magnitude float64,
angle float64,
) NumberLike
NumberFromRectangular(
real_ float64,
imaginary float64,
) NumberLike
NumberFromInteger(
integer int,
) NumberLike
NumberFromFloat(
float float64,
) NumberLike
NumberFromSource(
source string,
) NumberLike
// Constant Methods
Undefined() NumberLike
Zero() NumberLike
One() NumberLike
I() NumberLike
E() NumberLike
Pi() NumberLike
Phi() NumberLike
Tau() NumberLike
Minimum() NumberLike
Maximum() NumberLike
Infinity() NumberLike
// Function Methods
Inverse(
number NumberLike,
) NumberLike
Sum(
first NumberLike,
second NumberLike,
) NumberLike
Difference(
first NumberLike,
second NumberLike,
) NumberLike
Scaled(
number NumberLike,
factor float64,
) NumberLike
Reciprocal(
number NumberLike,
) NumberLike
Conjugate(
number NumberLike,
) NumberLike
Product(
first NumberLike,
second NumberLike,
) NumberLike
Quotient(
first NumberLike,
second NumberLike,
) NumberLike
Remainder(
first NumberLike,
second NumberLike,
) NumberLike
Power(
base NumberLike,
exponent NumberLike,
) NumberLike
Logarithm(
base NumberLike,
number NumberLike,
) NumberLike
}
NumberClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each number-like concrete class.
func NumberClass ¶
func NumberClass() NumberClassLike
type NumberLike ¶
type NumberLike interface {
// Principal Methods
GetClass() NumberClassLike
AsIntrinsic() complex128
AsRectangular() string
AsPolar() string
AsSource() string
GetReal() float64
GetImaginary() float64
GetMagnitude() float64
GetAngle() float64
// Aspect Interfaces
Continuous
Polarized
}
NumberLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a number-like class.
type PercentageClassLike ¶
type PercentageClassLike interface {
// Constructor Methods
Percentage(
float float64,
) PercentageLike
PercentageFromInteger(
integer int,
) PercentageLike
PercentageFromSource(
source string,
) PercentageLike
// Constant Methods
Undefined() PercentageLike
}
PercentageClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each percentage-like concrete class.
func PercentageClass ¶
func PercentageClass() PercentageClassLike
type PercentageLike ¶
type PercentageLike interface {
// Principal Methods
GetClass() PercentageClassLike
AsIntrinsic() float64
AsSource() string
// Aspect Interfaces
Continuous
Polarized
}
PercentageLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a percentage-like class.
type Polarized ¶
type Polarized interface {
IsNegative() bool
}
Polarized is an aspect interface that defines a set of method signatures that must be supported by each instance of a polarized class.
type ProbabilityClassLike ¶
type ProbabilityClassLike interface {
// Constructor Methods
Probability(
float float64,
) ProbabilityLike
ProbabilityFromBoolean(
boolean bool,
) ProbabilityLike
ProbabilityFromSource(
source string,
) ProbabilityLike
// Constant Methods
Undefined() ProbabilityLike
// Function Methods
Random() ProbabilityLike
Not(
probability ProbabilityLike,
) ProbabilityLike
And(
first ProbabilityLike,
second ProbabilityLike,
) ProbabilityLike
San(
first ProbabilityLike,
second ProbabilityLike,
) ProbabilityLike
Ior(
first ProbabilityLike,
second ProbabilityLike,
) ProbabilityLike
Xor(
first ProbabilityLike,
second ProbabilityLike,
) ProbabilityLike
}
ProbabilityClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each probability-like concrete class.
func ProbabilityClass ¶
func ProbabilityClass() ProbabilityClassLike
type ProbabilityLike ¶
type ProbabilityLike interface {
// Principal Methods
GetClass() ProbabilityClassLike
AsIntrinsic() float64
AsSource() string
// Aspect Interfaces
Continuous
}
ProbabilityLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a probability-like class.
type ResourceClassLike ¶
type ResourceClassLike interface {
// Constructor Methods
Resource(
uri string,
) ResourceLike
ResourceFromSource(
source string,
) ResourceLike
ResourceFromUri(
url *uri.URL,
) ResourceLike
// Constant Methods
Undefined() ResourceLike
}
ResourceClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each resource-like concrete class.
func ResourceClass ¶
func ResourceClass() ResourceClassLike
type ResourceLike ¶
type ResourceLike interface {
// Principal Methods
GetClass() ResourceClassLike
AsIntrinsic() string
AsSource() string
AsUri() *uri.URL
GetScheme() string
GetAuthority() string
GetPath() string
GetQuery() string
GetFragment() string
}
ResourceLike is an instance interface that defines the complete set of instance attributes, abstractions and methods that must be supported by each instance of a resource-like class.
type SymbolClassLike ¶
type SymbolClassLike interface {
// Constructor Methods
Symbol(
identifier string,
) SymbolLike
SymbolFromSource(
source string,
) SymbolLike
// Constant Methods
Undefined() SymbolLike
}
SymbolClassLike is a class interface that defines the complete set of class constants, constructors and functions that must be supported by each symbol-like concrete class.
func SymbolClass ¶
func SymbolClass() SymbolClassLike
type SymbolLike ¶
type SymbolLike interface {
// Principal Methods
GetClass() SymbolClassLike
AsIntrinsic() string
AsSource() string
}
SymbolLike is an instance interface that declares the complete set of principal, attribute and aspect methods that must be supported by each instance of a concrete symbol-like class.
type Temporal ¶
type Temporal interface {
AsMilliseconds() float64
AsSeconds() float64
AsMinutes() float64
AsHours() float64
AsDays() float64
AsWeeks() float64
AsMonths() float64
AsYears() float64
}
Temporal is an aspect interface that defines a set of method signatures that must be supported by each instance of a temporal class.
Source Files