Skip to content

Commit

Permalink
Improve NormalDistribution/probabilityDensity(at:) docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucca-mito committed Oct 4, 2024
1 parent b16e9ce commit 07ed533
Show file tree
Hide file tree
Showing 310 changed files with 310 additions and 309 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ extension NormalDistribution: ContinuousDistribution {
///
/// The density at $x$ is given by:
/// $$\frac{1}{\sqrt{2 \pi \sigma^2}} e^{-\frac{(x - \mu)^2}{2 \sigma^2}}$$
/// Where $\mu$ and $\sigma^2$ are the ``mean`` and ``variance`` of the normal distribution, respectively.
///
/// For the ``standard`` normal distribution, this function is sometimes denoted by $\operatorname{φ}(x)$.
public func probabilityDensity(at value: RealType) -> RealType {
Expand Down
2 changes: 1 addition & 1 deletion docs/data/documentation/science.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/science/bernoullidistribution.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"bottomOnePercent"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Value","preciseIdentifier":"s:7Science23ProbabilityDistributionP5ValueQa"}],"modules":[{"name":"Swift Science"}],"symbolKind":"property","conformance":{"constraints":[{"code":"Statistic","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"ExpressibleByFloatLiteral"},{"type":"text","text":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"remoteSource":{"fileName":"ClosedFormQuantile.swift","url":"https:\/\/github.com\/lucca-mito\/swift-science\/blob\/main\/Sources\/Science\/Statistics\/Probability%20Distribution%20Protocols\/ClosedFormQuantile.swift#L30"},"role":"symbol","externalID":"s:7Science18ClosedFormQuantilePAAs25ExpressibleByFloatLiteral9StatisticRpzrlE16bottomOnePercent5ValueQzvp::SYNTHESIZED::s:7Science21BernoulliDistributionV","title":"bottomOnePercent","extendedModule":"Science","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/bottomOnePercent"},"variants":[{"paths":["\/documentation\/science\/bernoullidistribution\/bottomonepercent"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/Science\/documentation\/Science","doc:\/\/Science\/documentation\/Science\/BernoulliDistribution","doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/ClosedFormQuantile-Implementations"]]},"abstract":[{"type":"text","text":"A first percentile of the distribution."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bottomOnePercent"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":".","kind":"text"},{"text":"Value","preciseIdentifier":"s:7Science23ProbabilityDistributionP5ValueQa","identifier":"doc:\/\/Science\/documentation\/Science\/ProbabilityDistribution\/Value","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"inlineContent":[{"type":"text","text":"If there are multiple, the smallest is chosen."}],"type":"paragraph"}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://Science/documentation/Science/BernoulliDistribution/ClosedFormQuantile-Implementations":{"kind":"article","type":"topic","identifier":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/ClosedFormQuantile-Implementations","url":"\/documentation\/science\/bernoullidistribution\/closedformquantile-implementations","title":"ClosedFormQuantile Implementations","abstract":[],"role":"collectionGroup"},"doc://Science/documentation/Science":{"kind":"symbol","identifier":"doc:\/\/Science\/documentation\/Science","title":"Swift Science","type":"topic","role":"collection","url":"\/documentation\/science","images":[{"type":"icon","identifier":"swift-science-icon.png"}],"abstract":[{"type":"text","text":"A scientific computing package for Swift."}]},"doc://Science/documentation/Science/BernoulliDistribution/bottomOnePercent":{"type":"topic","url":"\/documentation\/science\/bernoullidistribution\/bottomonepercent","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"bottomOnePercent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Value","kind":"typeIdentifier","preciseIdentifier":"s:7Science23ProbabilityDistributionP5ValueQa"}],"title":"bottomOnePercent","abstract":[{"text":"A first percentile of the distribution.","type":"text"}],"role":"symbol","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"Statistic","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"ExpressibleByFloatLiteral","type":"codeVoice"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"identifier":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/bottomOnePercent"},"doc://Science/documentation/Science/ProbabilityDistribution/Value":{"kind":"symbol","fragments":[{"text":"associatedtype","kind":"keyword"},{"kind":"text","text":" "},{"text":"Value","kind":"identifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SL","text":"Comparable","kind":"typeIdentifier"}],"url":"\/documentation\/science\/probabilitydistribution\/value","title":"Value","abstract":[{"type":"text","text":"The type of values from the distribution."}],"type":"topic","identifier":"doc:\/\/Science\/documentation\/Science\/ProbabilityDistribution\/Value","required":true,"role":"symbol"},"swift-science-icon.png":{"type":"image","identifier":"swift-science-icon.png","variants":[{"traits":["1x","light"],"url":"\/images\/Science\/swift-science-icon.png"}],"alt":"A technology icon representing the Swift Science framework."},"doc://Science/documentation/Science/BernoulliDistribution":{"title":"BernoulliDistribution","navigatorTitle":[{"text":"BernoulliDistribution","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BernoulliDistribution"}],"identifier":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution","type":"topic","url":"\/documentation\/science\/bernoullidistribution","abstract":[{"type":"text","text":"The probability distribution of a random variable that’s either 0 or 1."}],"kind":"symbol","role":"symbol"}}}
{"hierarchy":{"paths":[["doc:\/\/Science\/documentation\/Science","doc:\/\/Science\/documentation\/Science\/BernoulliDistribution","doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/ClosedFormQuantile-Implementations"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Swift Science"}],"externalID":"s:7Science18ClosedFormQuantilePAAs25ExpressibleByFloatLiteral9StatisticRpzrlE16bottomOnePercent5ValueQzvp::SYNTHESIZED::s:7Science21BernoulliDistributionV","title":"bottomOnePercent","role":"symbol","extendedModule":"Science","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"Statistic"},{"type":"text","text":" conforms to "},{"code":"ExpressibleByFloatLiteral","type":"codeVoice"},{"text":".","type":"text"}]},"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bottomOnePercent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":"."},{"text":"Value","kind":"typeIdentifier","preciseIdentifier":"s:7Science23ProbabilityDistributionP5ValueQa"}],"remoteSource":{"fileName":"ClosedFormQuantile.swift","url":"https:\/\/github.com\/lucca-mito\/swift-science\/blob\/main\/Sources\/Science\/Statistics\/Probability%20Distribution%20Protocols\/ClosedFormQuantile.swift#L30"},"roleHeading":"Instance Property"},"variants":[{"paths":["\/documentation\/science\/bernoullidistribution\/bottomonepercent"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"A first percentile of the distribution."}],"sections":[],"identifier":{"url":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/bottomOnePercent","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"bottomOnePercent","kind":"identifier"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Value","kind":"typeIdentifier","identifier":"doc:\/\/Science\/documentation\/Science\/ProbabilityDistribution\/Value","preciseIdentifier":"s:7Science23ProbabilityDistributionP5ValueQa"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are multiple, the smallest is chosen."}]}]}],"kind":"symbol","references":{"doc://Science/documentation/Science/BernoulliDistribution":{"identifier":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution","kind":"symbol","url":"\/documentation\/science\/bernoullidistribution","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"BernoulliDistribution","kind":"identifier"}],"abstract":[{"text":"The probability distribution of a random variable that’s either 0 or 1.","type":"text"}],"navigatorTitle":[{"text":"BernoulliDistribution","kind":"identifier"}],"title":"BernoulliDistribution","role":"symbol"},"doc://Science/documentation/Science/BernoulliDistribution/ClosedFormQuantile-Implementations":{"kind":"article","abstract":[],"title":"ClosedFormQuantile Implementations","role":"collectionGroup","identifier":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/ClosedFormQuantile-Implementations","url":"\/documentation\/science\/bernoullidistribution\/closedformquantile-implementations","type":"topic"},"swift-science-icon.png":{"alt":"A technology icon representing the Swift Science framework.","variants":[{"traits":["1x","light"],"url":"\/images\/Science\/swift-science-icon.png"}],"identifier":"swift-science-icon.png","type":"image"},"doc://Science/documentation/Science/ProbabilityDistribution/Value":{"identifier":"doc:\/\/Science\/documentation\/Science\/ProbabilityDistribution\/Value","kind":"symbol","url":"\/documentation\/science\/probabilitydistribution\/value","type":"topic","fragments":[{"text":"associatedtype","kind":"keyword"},{"kind":"text","text":" "},{"text":"Value","kind":"identifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"Comparable","preciseIdentifier":"s:SL"}],"required":true,"abstract":[{"text":"The type of values from the distribution.","type":"text"}],"title":"Value","role":"symbol"},"doc://Science/documentation/Science":{"type":"topic","role":"collection","identifier":"doc:\/\/Science\/documentation\/Science","title":"Swift Science","abstract":[{"text":"A scientific computing package for Swift.","type":"text"}],"kind":"symbol","url":"\/documentation\/science","images":[{"type":"icon","identifier":"swift-science-icon.png"}]},"doc://Science/documentation/Science/BernoulliDistribution/bottomOnePercent":{"url":"\/documentation\/science\/bernoullidistribution\/bottomonepercent","title":"bottomOnePercent","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"bottomOnePercent","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Value","preciseIdentifier":"s:7Science23ProbabilityDistributionP5ValueQa"}],"conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Statistic"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"ExpressibleByFloatLiteral"},{"text":".","type":"text"}]},"type":"topic","abstract":[{"type":"text","text":"A first percentile of the distribution."}],"identifier":"doc:\/\/Science\/documentation\/Science\/BernoulliDistribution\/bottomOnePercent"}}}
Loading

0 comments on commit 07ed533

Please sign in to comment.