Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mgriebling committed Oct 11, 2024
1 parent 5b1f52a commit 43f967f
Show file tree
Hide file tree
Showing 5,863 changed files with 5,064 additions and 2,394 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Binary file not shown.
9 changes: 9 additions & 0 deletions BigDecimal.doccarchive/css/866.60f074fd.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions BigDecimal.doccarchive/css/989.4f123103.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions BigDecimal.doccarchive/css/documentation-topic.91c07ba9.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions BigDecimal.doccarchive/css/index.3a335429.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions BigDecimal.doccarchive/css/topic.4be8f56d.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions BigDecimal.doccarchive/css/tutorials-overview.7942d777.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions BigDecimal.doccarchive/data/documentation/bigdecimal.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/init()"]},{"anchor":"Instance-Properties","generated":true,"title":"Instance Properties","identifiers":["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/calculateInPairs","doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/factors"]},{"title":"Instance Methods","generated":true,"identifiers":["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/calculateNextFactor()","doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/createPowerIterator(_:_:)","doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/getCurrentFactor()"],"anchor":"Instance-Methods"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/SeriesCalculator-Implementations"],"anchor":"Default-Implementations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Calculates arcsine using the Maclaurin\/Taylor series."}],"metadata":{"externalID":"s:10BigDecimal14AsinCalculatorV","symbolKind":"struct","roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"AsinCalculator"}],"title":"AsinCalculator","modules":[{"name":"BigDecimal"}],"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AsinCalculator","kind":"identifier"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AsinCalculator"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Overview","anchor":"overview","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"See Wikipedia: "},{"type":"reference","identifier":"https:\/\/en.wikipedia.org\/wiki\/Taylor_series","isActive":true},{"text":".","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"No argument checking or optimizations are done."},{"text":" ","type":"text"},{"type":"text","text":"This implementation is "},{"inlineContent":[{"type":"text","text":"not"}],"type":"strong"},{"type":"text","text":" intended to be called directly."}]}],"kind":"content"}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/SeriesCalculator","doc:\/\/bigdecimal.BigDecimal\/s8SendableP"],"kind":"relationships","title":"Conforms To"}],"hierarchy":{"paths":[["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal"]]},"variants":[{"paths":["\/documentation\/bigdecimal\/asincalculator"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator"},"sections":[],"references":{"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/calculateInPairs":{"url":"\/documentation\/bigdecimal\/asincalculator\/calculateinpairs","abstract":[],"kind":"symbol","role":"symbol","title":"calculateInPairs","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/calculateInPairs","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"calculateInPairs","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/SeriesCalculator-Implementations":{"url":"\/documentation\/bigdecimal\/asincalculator\/seriescalculator-implementations","type":"topic","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/SeriesCalculator-Implementations","role":"collectionGroup","abstract":[],"title":"SeriesCalculator Implementations","kind":"article"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/PowerIterator":{"navigatorTitle":[{"text":"PowerIterator","kind":"identifier"}],"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/PowerIterator","url":"\/documentation\/bigdecimal\/poweriterator","role":"symbol","title":"PowerIterator","abstract":[],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PowerIterator","kind":"identifier"}],"kind":"symbol","type":"topic"},"doc://bigdecimal.BigDecimal/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/bigdecimal.BigDecimal\/s8SendableP","title":"Swift.Sendable"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator":{"url":"\/documentation\/bigdecimal\/asincalculator","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AsinCalculator"}],"navigatorTitle":[{"text":"AsinCalculator","kind":"identifier"}],"kind":"symbol","title":"AsinCalculator","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Calculates arcsine using the Maclaurin\/Taylor series."}]},"https://en.wikipedia.org/wiki/Taylor_series":{"title":"Taylor Series","url":"https:\/\/en.wikipedia.org\/wiki\/Taylor_series","type":"link","titleInlineContent":[{"text":"Taylor Series","type":"text"}],"identifier":"https:\/\/en.wikipedia.org\/wiki\/Taylor_series"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/factors":{"url":"\/documentation\/bigdecimal\/asincalculator\/factors","abstract":[],"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/factors","title":"factors","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"factors"},{"kind":"text","text":": ["},{"text":"BigRational","kind":"typeIdentifier","preciseIdentifier":"s:10BigDecimal16SeriesCalculatorP0A8Rationala"},{"text":"]","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/calculateNextFactor()":{"type":"topic","abstract":[{"text":"Calculates the factor of the next term.","type":"text"}],"kind":"symbol","url":"\/documentation\/bigdecimal\/asincalculator\/calculatenextfactor()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"calculateNextFactor"},{"kind":"text","text":"()"}],"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/calculateNextFactor()","role":"symbol","title":"calculateNextFactor()"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal":{"url":"\/documentation\/bigdecimal","type":"topic","abstract":[{"text":"The BigDecimal package provides arbitrary-precision (with an adjustable upper","type":"text"},{"type":"text","text":" "},{"type":"text","text":"limit for performance) and fixed-precision decimal arithmetic in Swift."}],"title":"BigDecimal","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal","kind":"symbol","role":"collection"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/init()":{"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/init()","abstract":[],"type":"topic","url":"\/documentation\/bigdecimal\/asincalculator\/init()","title":"init()","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"()","kind":"text"}],"kind":"symbol"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/createPowerIterator(_:_:)":{"role":"symbol","title":"createPowerIterator(_:_:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"createPowerIterator"},{"text":"(","kind":"text"},{"text":"BigDecimal","kind":"typeIdentifier","preciseIdentifier":"s:10BigDecimalAAV"},{"kind":"text","text":", "},{"text":"Rounding","kind":"typeIdentifier","preciseIdentifier":"s:10BigDecimal8RoundingV"},{"text":") -> ","kind":"text"},{"text":"PowerIterator","kind":"typeIdentifier","preciseIdentifier":"s:10BigDecimal13PowerIteratorP"}],"kind":"symbol","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/createPowerIterator(_:_:)","url":"\/documentation\/bigdecimal\/asincalculator\/createpoweriterator(_:_:)","abstract":[{"type":"text","text":"Creates the "},{"type":"reference","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/PowerIterator","isActive":true},{"type":"text","text":" used for this series."}]},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/SeriesCalculator":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"SeriesCalculator"}],"navigatorTitle":[{"text":"SeriesCalculator","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/bigdecimal\/seriescalculator","type":"topic","abstract":[],"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/SeriesCalculator","title":"SeriesCalculator"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/getCurrentFactor()":{"abstract":[{"text":"Returns the factor of the highest term already calculated.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"When called for the first time will return the factor of the first term (index 0)."},{"type":"text","text":" "},{"text":"After this call the method ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/calculateNextFactor()"},{"text":" will be called to prepare for the next term.","type":"text"}],"title":"getCurrentFactor()","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getCurrentFactor"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"BigRational","preciseIdentifier":"s:10BigDecimal16SeriesCalculatorP0A8Rationala"}],"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/getCurrentFactor()","url":"\/documentation\/bigdecimal\/asincalculator\/getcurrentfactor()","role":"symbol"}}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/addFactor(_:)"},"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"SeriesCalculator.addFactor(_:)"},{"type":"text","text":"."}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"addFactor"},{"kind":"text","text":"(BigInt"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:6BigInt9BFractionV","text":"BFraction"},{"text":")","kind":"text"}],"title":"addFactor(_:)","role":"symbol","extendedModule":"BigDecimal","roleHeading":"Instance Method","modules":[{"name":"BigDecimal"}],"externalID":"s:10BigDecimal16SeriesCalculatorPAAE9addFactoryy0A3Int9BFractionVF::SYNTHESIZED::s:10BigDecimal14AsinCalculatorV","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal","doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator","doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/SeriesCalculator-Implementations"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bigdecimal\/asincalculator\/addfactor(_:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"addFactor"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"factor"},{"text":": BigInt","kind":"text"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:6BigInt9BFractionV","text":"BFraction"},{"text":")","kind":"text"}],"languages":["swift"]}]}],"references":{"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator":{"url":"\/documentation\/bigdecimal\/asincalculator","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AsinCalculator"}],"navigatorTitle":[{"text":"AsinCalculator","kind":"identifier"}],"kind":"symbol","title":"AsinCalculator","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Calculates arcsine using the Maclaurin\/Taylor series."}]},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/SeriesCalculator-Implementations":{"url":"\/documentation\/bigdecimal\/asincalculator\/seriescalculator-implementations","type":"topic","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/SeriesCalculator-Implementations","role":"collectionGroup","abstract":[],"title":"SeriesCalculator Implementations","kind":"article"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal/AsinCalculator/addFactor(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"addFactor","kind":"identifier"},{"kind":"text","text":"(BigInt"},{"kind":"text","text":"."},{"preciseIdentifier":"s:6BigInt9BFractionV","text":"BFraction","kind":"typeIdentifier"},{"kind":"text","text":")"}],"identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal\/AsinCalculator\/addFactor(_:)","abstract":[],"type":"topic","kind":"symbol","url":"\/documentation\/bigdecimal\/asincalculator\/addfactor(_:)","title":"addFactor(_:)","role":"symbol"},"doc://bigdecimal.BigDecimal/documentation/BigDecimal":{"url":"\/documentation\/bigdecimal","type":"topic","abstract":[{"text":"The BigDecimal package provides arbitrary-precision (with an adjustable upper","type":"text"},{"type":"text","text":" "},{"type":"text","text":"limit for performance) and fixed-precision decimal arithmetic in Swift."}],"title":"BigDecimal","identifier":"doc:\/\/bigdecimal.BigDecimal\/documentation\/BigDecimal","kind":"symbol","role":"collection"}}}
Loading

0 comments on commit 43f967f

Please sign in to comment.