@maboroshi/math-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

math-utils

数学ユーティリティ

インストール

 
npm install @maboroshi/math-utils

or

yarn add @maboroshi/math-utils

使い方

 
import { sum } from '@maboroshi/math-utils'

console.log(sum(1, 2, 3)) // => 6

API

API ドキュメント を見る

Index

Variables

Functions

Variables

Const PI2

PI2: number = Math.PI * 2

Functions

average

  • average(values: number[]): number

  • Parameters

    • Rest values: number[]

    Returns number

    values の平均値

clamp

  • clamp(value: number, minOrMax: number, max: undefined | number): number

  • Parameters

    • value: number
    • minOrMax: number
    • Optional max: undefined | number

    Returns number

    value を minOrMax 以上 max 以下に丸めて返す

direction

  • direction(x1: number, y1: number, x2?: number, y2?: number): number

  • Parameters

    • x1: number
    • y1: number
    • Default value x2: number = 0
    • Default value y2: number = 0

    Returns number

    始点（ x1, y1 ）から見た終点（ x2, y2 ）の方向をラジアンで返す

distance

  • distance(x1: number, y1: number, x2?: number, y2?: number): number

  • Parameters

    • x1: number
    • y1: number
    • Default value x2: number = 0
    • Default value y2: number = 0

    Returns number

    始点（ x1, y1 ）と終点（ x2, y2 ）の距離を返す

map

  • map(value: number, min1: number, max1: number, min2?: number, max2?: number): number

  • Parameters

    • value: number
    • min1: number
    • max1: number
    • Default value min2: number = min1
    • Default value max2: number = max1

    Returns number

    value を min1 以上 max1 以下の集合から min2 以上 max2 以下の集合へ写像したときの値を返す

mix

  • mix(x: number, y: number, a: number): number

  • Parameters

    • x: number
    • y: number
    • a: number

    Returns number

    始点 x から 終点 y の間にある点 a を返す

sum

  • sum(values: number[]): number

  • Parameters

    • Rest values: number[]

    Returns number

    values の合計値

weightedRandom

  • weightedRandom(weights: number[], binarySearch?: boolean): number

  • Parameters

    • weights: number[]
    • Default value binarySearch: boolean = weights.length > 9

    Returns number

    weights に基づいてランダムに weights のインデックスを返す

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc