Documentation | Contributing | Code of Conduct

import "atomicgo.dev/constraints"

Package constraints provides constraints for type parameters aka. generics in Go.

This is a more comprehensive drop-in replacement for golang.org/x/exp/constraints.

• type Addable
• type Comparable
• type Complex
• type Float
• type Integer
• type Number
• type Numeric
• type Orderable
• type Ordered
• type Signed
• type Unsigned

Addable is a constraint that matches any type that can be added with the + operator.

type Addable interface {
    Number | ~string
}

Comparable is a constraint that matches any type that can be compared with the == and != operators.

type Comparable interface {
    comparable
}

Complex is a constraint that matches any complex number type.

type Complex interface {
    ~complex64 | ~complex128
}

Float is a constraint that matches any floating point number type.

type Float interface {
    ~float32 | ~float64
}

Integer is a constraint that matches any integer type.

type Integer interface {
    Signed | Unsigned
}

Number is a constraint that matches any real number type. The Number constraint does not include Complex numbers, as those are not ordered. If you also need Complex numbers, use the Numeric constraint.

type Number interface {
    Float | Integer
}

Numeric is a constraint that matches any numeric type, including complex numbers.

type Numeric interface {
    Number | Complex
}

Orderable is a constraint that matches any type that can be ordered with the <, <=, >, and >= operators.

type Orderable interface {
    Integer | Float | ~string
}

Ordered is a constraint that matches any ordered type.

type Ordered interface {
    Integer | Float | ~string
}

Signed is a constraint that matches any signed integer type.

type Signed interface {
    ~int | ~int8 | ~int16 | ~int32 | ~int64
}

Unsigned is a constraint that matches any unsigned integer type.

type Unsigned interface {
    ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr
}

Generated by gomarkdoc

AtomicGo.dev  ·  with ❤️ by @MarvinJWendt | MarvinJWendt.com