Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FactorGradient

Class used to store factor gradient

Hierarchy

  • FactorGradient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FactorGradient(gradient: number, factor1: number, factor2?: number | undefined): FactorGradient
  • Creates a new factor gradient

    Parameters

    • gradient: number

      gets or sets the gradient value (between 0 and 1)

    • factor1: number

      gets or sets first associated factor

    • Optional factor2: number | undefined

      gets or sets second associated factor

    Returns FactorGradient

Properties

factor1Search playground for factor1

factor1: number

Gets or sets first associated factor

Optional factor2Search playground for factor2

factor2: number | undefined

Gets or sets second associated factor

gradientSearch playground for gradient

gradient: number

Gets or sets the gradient value (between 0 and 1)

Methods

getFactorSearch playground for getFactor

  • getFactor(): number
  • Will get a number picked randomly between factor1 and factor2. If factor2 is undefined then factor1 will be used

    Returns number

    the picked number

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method