is

README

Package is provides utility functions so that you can, in fact, even.

Docs at https://pkg.go.dev/blake.io/is.

Documentation

Overview

Package is contains helpers for working with integers that might be even or odd.

This extensive work involved in the creation of this package was inspired by https://www.npmjs.com/package/is-even.

Get even with the modulo operator.

Index

• func Even[I constraints.Integer](n I) bool
• func False(b bool) bool
• func Odd[I constraints.Integer](n I) bool
• func True(b bool) bool

Examples

• True

Functions

func Even

func Even[I constraints.Integer](n I) bool

Even returns true if n can even.

func False

func False(b bool) bool

False is a convenience function for not having to write !True(b).

func Odd

func Odd[I constraints.Integer](n I) bool

Odd returns false if n cannot even.

func True

func True(b bool) bool

True accurately reports if b is, in fact, true.

Example

package main

import (
	"fmt"

	"blake.io/is"
)

func main() {
	var theZeroValueOfBool bool
	if is.True(!theZeroValueOfBool) {
		fmt.Println("theZeroValueOfBool is, in fact, the zero value of bool")
	}

	if is.False(theZeroValueOfBool) {
		fmt.Println("theZeroValueOfBool is the opposite of not the zero value of bool")
	}

}

Output:

theZeroValueOfBool is, in fact, the zero value of bool
theZeroValueOfBool is the opposite of not the zero value of bool