N · Built-in API

On this page

Every signature below comes from the current compiler’s public API. Overloads share a heading. BYREF requires exclusive writable access; TAKE transfers ownership; FAILS lists checked errors. See the teaching chapters and library references for behavior and examples.

NaN

FUNCTION NaN() AS DOUBLE

NanosecondFraction

FUNCTION NanosecondFraction(value AS TimeOfDay) AS INTEGER
FUNCTION NanosecondFraction(value AS Instant) AS INTEGER
FUNCTION NanosecondFraction(value AS Duration) AS INTEGER

Nanoseconds

FUNCTION Nanoseconds(value AS INTEGER) AS Duration

NegateDuration

FUNCTION NegateDuration(value AS Duration) AS Duration FAILS DateTimeError

NegatePeriod

FUNCTION NegatePeriod(value AS Period) AS Period FAILS DateTimeError

NewAnimation

FUNCTION NewAnimation(width AS INTEGER,height AS INTEGER,plays AS INTEGER=1,maxDecodedBytes AS INTEGER=268435456) AS Animation FAILS CanvasError

NewBitSet

FUNCTION NewBitSet(size AS INTEGER) AS BitSet FAILS CollectionError,IndexError

NewBoundedDeque

FUNCTION NewBoundedDeque[T](capacity AS INTEGER) AS BoundedDeque[T] FAILS CollectionError

NewCache

FUNCTION NewCache[K,V](maxEntries AS INTEGER,policy AS CachePolicy=CachePolicy.LRU,expireAfter AS OPTIONAL OF Duration=NONE,maxWeight AS INTEGER=0) AS Cache[K,V] FAILS CollectionError

NewCanvas

FUNCTION NewCanvas(width AS INTEGER,height AS INTEGER,maxPixels AS INTEGER=16777216) AS Canvas FAILS CanvasError,NumericError,IndexError

NewCounter

FUNCTION NewCounter[T]() AS Counter[T]

NewDate

FUNCTION NewDate(year AS INTEGER,month AS INTEGER,day AS INTEGER) AS Date FAILS DateTimeError
FUNCTION NewDate(year AS INTEGER,month AS Month,day AS INTEGER) AS Date FAILS DateTimeError

NewDateInterval

FUNCTION NewDateInterval(start AS Date,finish AS Date) AS DateInterval FAILS DateTimeError

NewDateTimeAmount

FUNCTION NewDateTimeAmount(calendar AS Period,exact AS Duration) AS DateTimeAmount

NewDeque

FUNCTION NewDeque[T]() AS Deque[T]

NewDuration

FUNCTION NewDuration(seconds AS INTEGER,nanoseconds AS INTEGER=0) AS Duration FAILS DateTimeError

NewFontSet

FUNCTION NewFontSet() AS FontSet

NewInstantInterval

FUNCTION NewInstantInterval(start AS Instant,finish AS Instant) AS InstantInterval FAILS DateTimeError

NewIsoWeekDate

FUNCTION NewIsoWeekDate(year AS INTEGER,week AS INTEGER,weekday AS INTEGER) AS IsoWeekDate FAILS DateTimeError
FUNCTION NewIsoWeekDate(year AS INTEGER,week AS INTEGER,weekday AS Weekday) AS IsoWeekDate FAILS DateTimeError

NewLocalDateTime

FUNCTION NewLocalDateTime(value AS Date,time AS TimeOfDay) AS LocalDateTime
FUNCTION NewLocalDateTime(year AS INTEGER,month AS INTEGER,day AS INTEGER,hour AS INTEGER=0,minute AS INTEGER=0,second AS INTEGER=0,nanosecond AS INTEGER=0) AS LocalDateTime FAILS DateTimeError
FUNCTION NewLocalDateTime(year AS INTEGER,month AS Month,day AS INTEGER,hour AS INTEGER=0,minute AS INTEGER=0,second AS INTEGER=0,nanosecond AS INTEGER=0) AS LocalDateTime FAILS DateTimeError

NewMonthDay

FUNCTION NewMonthDay(month AS INTEGER,day AS INTEGER) AS MonthDay FAILS DateTimeError
FUNCTION NewMonthDay(month AS Month,day AS INTEGER) AS MonthDay FAILS DateTimeError

NewMultiMap

FUNCTION NewMultiMap[K,V]() AS MultiMap[K,V]

NewOffsetDateTime

FUNCTION NewOffsetDateTime(value AS LocalDateTime,offset AS UtcOffset) AS OffsetDateTime FAILS DateTimeError

NewOffsetTime

FUNCTION NewOffsetTime(value AS TimeOfDay,offset AS UtcOffset) AS OffsetTime

NewOrderedDictionary

FUNCTION NewOrderedDictionary[K,V]() AS DICT OF K TO V

NewOrderedSet

FUNCTION NewOrderedSet[T]() AS SET OF T

NewPath

FUNCTION NewPath() AS CanvasPath

NewPeriod

FUNCTION NewPeriod(years AS INTEGER=0,months AS INTEGER=0,weeks AS INTEGER=0,days AS INTEGER=0) AS Period FAILS DateTimeError

NewPriorityQueue

FUNCTION NewPriorityQueue[T]() AS PriorityQueue[T]

NewQueue

FUNCTION NewQueue[T]() AS Queue[T]

NewRandom

FUNCTION NewRandom(seed AS UINT64,stream AS UINT64=&H36) AS RandomGenerator
FUNCTION NewRandom(seed AS INTEGER,stream AS INTEGER=54) AS RandomGenerator

NewSortedDictionary

FUNCTION NewSortedDictionary[K,V]() AS SortedDictionary[K,V]

NewSortedSet

FUNCTION NewSortedSet[T]() AS SortedSet[T]

NewSystemClock

FUNCTION NewSystemClock(basis AS MonotonicBasis=MonotonicBasis.ActiveTime) AS Clock FAILS DateTimeError

NewTestClock

FUNCTION NewTestClock(wall AS Instant) AS Clock FAILS DateTimeError

NewTextDecoder

FUNCTION NewTextDecoder(encoding AS TextEncoding,errors AS TextErrorPolicy=TextErrorPolicy.Strict,bom AS TextDecodeBom=TextDecodeBom.Preserve,maxOutputBytes AS INTEGER=67108864) AS TextDecoder FAILS TextEncodingError

NewTextEncoder

FUNCTION NewTextEncoder(encoding AS TextEncoding,errors AS TextErrorPolicy=TextErrorPolicy.Strict,bom AS TextEncodeBom=TextEncodeBom.Omit,maxOutputBytes AS INTEGER=67108864) AS TextEncoder FAILS TextEncodingError

NewTime

FUNCTION NewTime(hour AS INTEGER,minute AS INTEGER=0,second AS INTEGER=0,nanosecond AS INTEGER=0) AS TimeOfDay FAILS DateTimeError

NewTimedCache

FUNCTION NewTimedCache[K,V](maxEntries AS INTEGER,policy AS CachePolicy,expireAfter AS Duration,now AS MonotonicInstant,maxWeight AS INTEGER=0) AS Cache[K,V] FAILS CollectionError

NewTransitionZone

FUNCTION NewTransitionZone(id AS STRING,initial AS UtcOffset,changes AS LIST OF ZoneTransition,futureKnown AS BOOLEAN=TRUE) AS TimeZone FAILS DateTimeError

NewUtcOffset

FUNCTION NewUtcOffset(seconds AS INTEGER) AS UtcOffset FAILS DateTimeError

NewUUIDClockGenerator

FUNCTION NewUUIDClockGenerator() AS UUIDClockGenerator FAILS IoError

NewYearMonth

FUNCTION NewYearMonth(year AS INTEGER,month AS INTEGER) AS YearMonth FAILS DateTimeError
FUNCTION NewYearMonth(year AS INTEGER,month AS Month) AS YearMonth FAILS DateTimeError

NEXTAFTER

FUNCTION NEXTAFTER(value AS DOUBLE, toward AS DOUBLE) AS DOUBLE

NextDouble

FUNCTION NextDouble(BYREF generator AS RandomGenerator) AS DOUBLE

NextInteger

FUNCTION NextInteger(BYREF generator AS RandomGenerator,upper AS INTEGER) AS INTEGER FAILS NumericError

NextTransition

FUNCTION NextTransition(value AS TimeZone,instant AS Instant) AS OPTIONAL OF ZoneTransition FAILS DateTimeError

NextUInt32

FUNCTION NextUInt32(BYREF generator AS RandomGenerator) AS UINT32

NextUInt64

FUNCTION NextUInt64(BYREF generator AS RandomGenerator) AS UINT64

NextUUIDv1

FUNCTION NextUUIDv1(BYREF generator AS UUIDClockGenerator) AS UUID FAILS UuidError,IoError

NextUUIDv1AtTicks

FUNCTION NextUUIDv1AtTicks(BYREF generator AS UUIDClockGenerator,ticks AS UINT64) AS UUID FAILS UuidError

NextUUIDv6

FUNCTION NextUUIDv6(BYREF generator AS UUIDClockGenerator) AS UUID FAILS UuidError,IoError

NextUUIDv6AtTicks

FUNCTION NextUUIDv6AtTicks(BYREF generator AS UUIDClockGenerator,ticks AS UINT64) AS UUID FAILS UuidError

NilUUID

FUNCTION NilUUID() AS UUID

NominalBetween

FUNCTION NominalBetween(start AS LocalDateTime,finish AS LocalDateTime) AS Duration FAILS DateTimeError

Norm

FUNCTION Norm(values AS LIST OF DOUBLE) AS DOUBLE
FUNCTION Norm(values AS LIST OF INTEGER) AS DOUBLE
FUNCTION Norm(values AS LIST OF BYTE) AS DOUBLE
FUNCTION Norm(values AS LIST OF UINT32) AS DOUBLE
FUNCTION Norm(values AS LIST OF UINT64) AS DOUBLE
FUNCTION Norm(values AS ARRAY OF DOUBLE) AS DOUBLE FAILS VectorRankError
FUNCTION Norm(values AS ARRAY OF INTEGER) AS DOUBLE FAILS VectorRankError
FUNCTION Norm(values AS ARRAY OF BYTE) AS DOUBLE FAILS VectorRankError
FUNCTION Norm(values AS ARRAY OF UINT32) AS DOUBLE FAILS VectorRankError
FUNCTION Norm(values AS ARRAY OF UINT64) AS DOUBLE FAILS VectorRankError

Normalized

FUNCTION Normalized(values AS LIST OF DOUBLE) AS LIST OF DOUBLE FAILS ZeroVectorError
FUNCTION Normalized(values AS LIST OF INTEGER) AS LIST OF DOUBLE FAILS ZeroVectorError
FUNCTION Normalized(values AS LIST OF BYTE) AS LIST OF DOUBLE FAILS ZeroVectorError
FUNCTION Normalized(values AS LIST OF UINT32) AS LIST OF DOUBLE FAILS ZeroVectorError
FUNCTION Normalized(values AS LIST OF UINT64) AS LIST OF DOUBLE FAILS ZeroVectorError
FUNCTION Normalized(values AS ARRAY OF DOUBLE) AS LIST OF DOUBLE FAILS ZeroVectorError,VectorRankError
FUNCTION Normalized(values AS ARRAY OF INTEGER) AS LIST OF DOUBLE FAILS ZeroVectorError,VectorRankError
FUNCTION Normalized(values AS ARRAY OF BYTE) AS LIST OF DOUBLE FAILS ZeroVectorError,VectorRankError
FUNCTION Normalized(values AS ARRAY OF UINT32) AS LIST OF DOUBLE FAILS ZeroVectorError,VectorRankError
FUNCTION Normalized(values AS ARRAY OF UINT64) AS LIST OF DOUBLE FAILS ZeroVectorError,VectorRankError

NormalizeURL

FUNCTION NormalizeURL(BYVAL value AS URL,removeDefaultPort AS BOOLEAN=FALSE) AS URL FAILS UrlError
FUNCTION NormalizeURL(text AS STRING,removeDefaultPort AS BOOLEAN=FALSE) AS STRING FAILS UrlError

NowInstant

FUNCTION NowInstant() AS Instant FAILS DateTimeError
FUNCTION NowInstant(clock AS Clock) AS Instant FAILS DateTimeError

NowInZone

FUNCTION NowInZone(clock AS Clock,zone AS TimeZone) AS ZonedDateTime FAILS DateTimeError

NowMonotonic

FUNCTION NowMonotonic(clock AS Clock) AS MonotonicInstant FAILS DateTimeError

Find your way around BASIL

Type to search the manual.