Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ base.dists.invgamma.mean,"\nbase.dists.invgamma.mean( α, β )\n Returns the
base.dists.invgamma.mode,"\nbase.dists.invgamma.mode( α, β )\n Returns the mode of an inverse gamma distribution.\n\n If `α <= 0` or `β <= 0`, the function returns `NaN`.\n\n If `α` or `β` is `NaN`, the function returns `NaN`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Rate parameter.\n\n Returns\n -------\n out: number\n Mode.\n\n Examples\n --------\n > var v = base.dists.invgamma.mode( 1.0, 1.0 )\n 0.5\n > v = base.dists.invgamma.mode( 4.0, 12.0 )\n 2.4\n > v = base.dists.invgamma.mode( 8.0, 2.0 )\n ~0.222\n\n"
base.dists.invgamma.pdf,"\nbase.dists.invgamma.pdf( x, α, β )\n Evaluates the probability density function (PDF) for an inverse gamma\n distribution with shape parameter `α` and scale parameter `β` at a value\n `x`.\n\n If `α <= 0` or `β <= 0`, the function returns `NaN`.\n\n If provided `NaN` as any argument, the function returns `NaN`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n out: number\n Evaluated PDF.\n\n Examples\n --------\n > var y = base.dists.invgamma.pdf( 2.0, 0.5, 1.0 )\n ~0.121\n > y = base.dists.invgamma.pdf( 0.2, 1.0, 1.0 )\n ~0.168\n > y = base.dists.invgamma.pdf( -1.0, 4.0, 2.0 )\n 0.0\n\n > y = base.dists.invgamma.pdf( NaN, 1.0, 1.0 )\n NaN\n > y = base.dists.invgamma.pdf( 0.0, NaN, 1.0 )\n NaN\n > y = base.dists.invgamma.pdf( 0.0, 1.0, NaN )\n NaN\n\n // Negative shape parameter:\n > y = base.dists.invgamma.pdf( 2.0, -1.0, 1.0 )\n NaN\n\n // Negative scale parameter:\n > y = base.dists.invgamma.pdf( 2.0, 1.0, -1.0 )\n NaN\n\n\nbase.dists.invgamma.pdf.factory( α, β )\n Returns a function for evaluating the probability density function (PDF)\n of an inverse gamma distribution with shape parameter `α` and scale\n parameter `β`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n pdf: Function\n Probability density function (PDF).\n\n Examples\n --------\n > var myPDF = base.dists.invgamma.pdf.factory( 6.0, 7.0 );\n > var y = myPDF( 2.0 )\n ~0.231\n\n"
base.dists.invgamma.pdf.factory,"\nbase.dists.invgamma.pdf.factory( α, β )\n Returns a function for evaluating the probability density function (PDF)\n of an inverse gamma distribution with shape parameter `α` and scale\n parameter `β`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n pdf: Function\n Probability density function (PDF).\n\n Examples\n --------\n > var myPDF = base.dists.invgamma.pdf.factory( 6.0, 7.0 );\n > var y = myPDF( 2.0 )\n ~0.231"
base.dists.invgamma.quantile,"\nbase.dists.invgamma.quantile( p, α, β )\n Evaluates the quantile function for an inverse gamma distribution with shape\n parameter `α` and scale parameter `β` at a probability `p`.\n\n If `p < 0` or `p > 1`, the function returns `NaN`.\n\n If `α <= 0` or `β <= 0`, the function returns `NaN`.\n\n If provided `NaN` as any argument, the function returns `NaN`.\n\n Parameters\n ----------\n p: number\n Input probability.\n\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n out: number\n Evaluated quantile function.\n\n Examples\n --------\n > var y = base.dists.invgamma.quantile( 0.8, 2.0, 1.0 )\n ~1.213\n > y = base.dists.invgamma.quantile( 0.5, 4.0, 2.0 )\n ~0.545\n > y = base.dists.invgamma.quantile( 1.1, 1.0, 1.0 )\n NaN\n > y = base.dists.invgamma.quantile( -0.2, 1.0, 1.0 )\n NaN\n\n > y = base.dists.invgamma.quantile( NaN, 1.0, 1.0 )\n NaN\n > y = base.dists.invgamma.quantile( 0.0, NaN, 1.0 )\n NaN\n > y = base.dists.invgamma.quantile( 0.0, 1.0, NaN )\n NaN\n\n // Non-positive shape parameter:\n > y = base.dists.invgamma.quantile( 0.5, -1.0, 1.0 )\n NaN\n\n // Non-positive rate parameter:\n > y = base.dists.invgamma.quantile( 0.5, 1.0, -1.0 )\n NaN\n\n\nbase.dists.invgamma.quantile.factory( α, β )\n Returns a function for evaluating the quantile function of an inverse gamma\n distribution with shape parameter `α` and scale parameter `β`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n quantile: Function\n Quantile function.\n\n Examples\n --------\n > var myQuantile = base.dists.invgamma.quantile.factory( 2.0, 2.0 );\n > var y = myQuantile( 0.8 )\n ~2.426\n > y = myQuantile( 0.4 )\n ~0.989\n\n"
base.dists.invgamma.quantile,"\nbase.dists.invgamma.quantile( p, α, β )\n Evaluates the quantile function for an inverse gamma distribution with shape\n parameter `α` and scale parameter `β` at a probability `p`.\n\n If `p < 0` or `p > 1`, the function returns `NaN`.\n\n If `α <= 0` or `β <= 0`, the function returns `NaN`.\n\n If provided `NaN` as any argument, the function returns `NaN`.\n\n Parameters\n ----------\n p: number\n Input probability.\n\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n out: number\n Evaluated quantile function.\n\n Examples\n --------\n > var y = base.dists.invgamma.quantile( 0.8, 2.0, 1.0 )\n ~1.213\n > y = base.dists.invgamma.quantile( 0.5, 4.0, 2.0 )\n ~0.545\n > y = base.dists.invgamma.quantile( 1.1, 1.0, 1.0 )\n NaN\n > y = base.dists.invgamma.quantile( -0.2, 1.0, 1.0 )\n NaN\n\n > y = base.dists.invgamma.quantile( NaN, 1.0, 1.0 )\n NaN\n > y = base.dists.invgamma.quantile( 0.0, NaN, 1.0 )\n NaN\n > y = base.dists.invgamma.quantile( 0.0, 1.0, NaN )\n NaN\n\n // Non-positive shape parameter:\n > y = base.dists.invgamma.quantile( 0.5, -1.0, 1.0 )\n NaN\n\n // Non-positive scale parameter:\n > y = base.dists.invgamma.quantile( 0.5, 1.0, -1.0 )\n NaN\n\n\nbase.dists.invgamma.quantile.factory( α, β )\n Returns a function for evaluating the quantile function of an inverse gamma\n distribution with shape parameter `α` and scale parameter `β`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n quantile: Function\n Quantile function.\n\n Examples\n --------\n > var myQuantile = base.dists.invgamma.quantile.factory( 2.0, 2.0 );\n > var y = myQuantile( 0.8 )\n ~2.426\n > y = myQuantile( 0.4 )\n ~0.989\n\n"
base.dists.invgamma.quantile.factory,"\nbase.dists.invgamma.quantile.factory( α, β )\n Returns a function for evaluating the quantile function of an inverse gamma\n distribution with shape parameter `α` and scale parameter `β`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Scale parameter.\n\n Returns\n -------\n quantile: Function\n Quantile function.\n\n Examples\n --------\n > var myQuantile = base.dists.invgamma.quantile.factory( 2.0, 2.0 );\n > var y = myQuantile( 0.8 )\n ~2.426\n > y = myQuantile( 0.4 )\n ~0.989"
base.dists.invgamma.skewness,"\nbase.dists.invgamma.skewness( α, β )\n Returns the skewness of an inverse gamma distribution.\n\n If `α <= 3` or `β <= 0`, the function returns `NaN`.\n\n If `α` or `β` is `NaN`, the function returns `NaN`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Rate parameter.\n\n Returns\n -------\n out: number\n Skewness.\n\n Examples\n --------\n > var v = base.dists.invgamma.skewness( 4.0, 12.0 )\n ~5.657\n > v = base.dists.invgamma.skewness( 8.0, 2.0 )\n ~1.96\n\n"
base.dists.invgamma.stdev,"\nbase.dists.invgamma.stdev( α, β )\n Returns the standard deviation of an inverse gamma distribution.\n\n If `α <= 2` or `β <= 0`, the function returns `NaN`.\n\n If `α` or `β` is `NaN`, the function returns `NaN`.\n\n Parameters\n ----------\n α: number\n Shape parameter.\n\n β: number\n Rate parameter.\n\n Returns\n -------\n out: number\n Standard deviation.\n\n Examples\n --------\n > var v = base.dists.invgamma.stdev( 5.0, 7.0 )\n ~1.01\n > v = base.dists.invgamma.stdev( 4.0, 12.0 )\n ~2.828\n > v = base.dists.invgamma.stdev( 8.0, 2.0 )\n ~0.117\n\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.