smartgrid.agents.profile.comfort.richard_curve

smartgrid.agents.profile.comfort.richard_curve(x, a=0.0, k=1.0, b=1.0, v=1.0, q=1.0, c=1.0, m=0.0) float[source]

Richard’s Curve or Generalised logistic function.

See https://en.wikipedia.org/wiki/Generalised_logistic_function for more details about the parameters. This function is used internally to build the comfort functions, by specifying various values for the parameters.

Parameters:
  • x – The X value used to evaluate the function

  • a – The lower asymptote

  • k – The upper asymptote

  • b – The growth rate

  • v – Affects near which asymptote maximum growth occurs

  • q – Related to the value of the curve at X=M (starting point, y0)

  • c – Typically 1, otherwise it will shift the upper asymptote

  • m – Starting point

Returns:

The value of the curve at x.