Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mgriebling committed Oct 10, 2024
1 parent 552de28 commit 8eff157
Show file tree
Hide file tree
Showing 689 changed files with 709 additions and 702 deletions.
2 changes: 1 addition & 1 deletion BigInt.doccarchive/data/documentation/bigint.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion BigInt.doccarchive/data/documentation/bigint/aboutcrt.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bigint\/aboutcrt"]}],"abstract":[{"text":"Chinese Remainder Theorem","type":"text"}],"kind":"article","metadata":{"modules":[{"name":"BigInt"}],"roleHeading":"Article","title":"About CRT","role":"article"},"identifier":{"url":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutCRT","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"content","content":[{"text":"Overview","anchor":"Overview","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"Create a CRT instance from a given set of moduli which fullfill the following conditions:"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"text","text":"at least two moduli"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"all moduli are positive"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"the moduli are pairwise coprime"}]}]}]},{"inlineContent":[{"text":"Then use the ","type":"text"},{"code":"compute","type":"codeVoice"},{"text":" method to compute the CRT value for a given set of residues.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The same CRT instance can be used for different inputs, as long as the moduli are the same.","type":"text"}],"type":"paragraph"},{"type":"heading","level":3,"text":"Example","anchor":"Example"},{"syntax":"swift","code":["let moduli = [3, 5, 7]","let crt = CRT(moduli)!","","let residues = [2, 2, 6]","print(\"CRT value:\", crt.compute(residues))"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"giving:"}]},{"code":["CRT value: 62"],"type":"codeListing","syntax":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/bigint.BigInt\/documentation\/BigInt"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"anchor":"Articles","identifiers":["doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBInt","doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBFraction","doc:\/\/bigint.BigInt\/documentation\/BigInt\/Performance","doc:\/\/bigint.BigInt\/documentation\/BigInt\/References","doc:\/\/bigint.BigInt\/documentation\/BigInt\/Algorithms","doc:\/\/bigint.BigInt\/documentation\/BigInt\/Protocols"],"title":"Articles","generated":true}],"references":{"doc://bigint.BigInt/documentation/BigInt":{"title":"BigInt","abstract":[{"text":"Signed integers and fractions of unbounded size","type":"text"}],"kind":"symbol","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt","role":"collection","type":"topic","url":"\/documentation\/bigint"},"doc://bigint.BigInt/documentation/BigInt/AboutBFraction":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBFraction","url":"\/documentation\/bigint\/aboutbfraction","type":"topic","role":"article","kind":"article","abstract":[{"type":"text","text":"Signed fractions with numerator and denominator of unbounded size"}],"title":"About BFraction"},"doc://bigint.BigInt/documentation/BigInt/Algorithms":{"kind":"article","title":"Algorithms","role":"article","type":"topic","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/Algorithms","url":"\/documentation\/bigint\/algorithms","abstract":[{"type":"text","text":"Some of the algorithms used in BigInt are described below"}]},"doc://bigint.BigInt/documentation/BigInt/Performance":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/Performance","url":"\/documentation\/bigint\/performance","type":"topic","role":"article","kind":"article","abstract":[{"text":"Execution times for certain BigInt operations","type":"text"}],"title":"Performance"},"doc://bigint.BigInt/documentation/BigInt/References":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/References","kind":"article","type":"topic","url":"\/documentation\/bigint\/references","title":"References","role":"article","abstract":[{"text":"Algorithms from the following books and papers have been used in the implementation","type":"text"}]},"doc://bigint.BigInt/documentation/BigInt/AboutBInt":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBInt","kind":"article","type":"topic","url":"\/documentation\/bigint\/aboutbint","title":"About BInt","role":"article","abstract":[{"type":"text","text":"Signed integers of unbounded size"}]},"doc://bigint.BigInt/documentation/BigInt/Protocols":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/Protocols","url":"\/documentation\/bigint\/protocols","type":"topic","role":"article","kind":"article","abstract":[{"type":"text","text":"BigInt supports Apple’s "},{"type":"codeVoice","code":"SignedInteger"},{"text":", ","type":"text"},{"type":"codeVoice","code":"BinaryInteger"},{"type":"text","text":", "},{"type":"codeVoice","code":"Codable"},{"text":", and ","type":"text"},{"type":"codeVoice","code":"Numeric"},{"text":" protocols.","type":"text"}],"title":"Protocols and Additions"}}}
{"abstract":[{"type":"text","text":"Chinese Remainder Theorem"}],"metadata":{"modules":[{"name":"BigInt"}],"role":"article","title":"About CRT","roleHeading":"Article"},"hierarchy":{"paths":[["doc:\/\/bigint.BigInt\/documentation\/BigInt"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"content":[{"type":"heading","anchor":"Overview","text":"Overview","level":2},{"inlineContent":[{"text":"Create a CRT instance from a given set of moduli which fullfill the following conditions:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"type":"text","text":"at least two moduli"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"all moduli are positive"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"the moduli are pairwise coprime","type":"text"}]}]}],"type":"unorderedList"},{"inlineContent":[{"text":"Then use the ","type":"text"},{"code":"compute","type":"codeVoice"},{"type":"text","text":" method to compute the CRT value for a given set of residues."}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"text":"The same CRT instance can be used for different inputs, as long as the moduli are the same.","type":"text"}]},{"level":3,"text":"Example","type":"heading","anchor":"Example"},{"type":"codeListing","code":["let moduli = [3, 5, 7]","let crt = CRT(moduli)!","","let residues = [2, 2, 6]","print(\"CRT value:\", crt.compute(residues))"],"syntax":"swift"},{"inlineContent":[{"text":"giving:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["CRT value: 62"],"type":"codeListing"}],"kind":"content"}],"kind":"article","seeAlsoSections":[{"identifiers":["doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBInt","doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBFraction","doc:\/\/bigint.BigInt\/documentation\/BigInt\/Performance","doc:\/\/bigint.BigInt\/documentation\/BigInt\/References","doc:\/\/bigint.BigInt\/documentation\/BigInt\/Algorithms","doc:\/\/bigint.BigInt\/documentation\/BigInt\/Protocols"],"title":"Articles","generated":true,"anchor":"Articles"}],"identifier":{"url":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutCRT","interfaceLanguage":"swift"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bigint\/aboutcrt"]}],"references":{"doc://bigint.BigInt/documentation/BigInt/AboutBInt":{"abstract":[{"type":"text","text":"Signed integers of unbounded size"}],"type":"topic","kind":"article","url":"\/documentation\/bigint\/aboutbint","role":"article","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBInt","title":"About BInt"},"doc://bigint.BigInt/documentation/BigInt/Protocols":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/Protocols","kind":"article","type":"topic","role":"article","title":"Protocols and Additions","abstract":[{"type":"text","text":"BigInt supports the standard integer data type’s SignedInteger, BinaryInteger, Codable, and Numeric protocols."}],"url":"\/documentation\/bigint\/protocols"},"doc://bigint.BigInt/documentation/BigInt/References":{"title":"References","type":"topic","abstract":[{"type":"text","text":"Algorithms from the following books and papers have been used in the implementation"}],"url":"\/documentation\/bigint\/references","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/References","role":"article","kind":"article"},"doc://bigint.BigInt/documentation/BigInt":{"title":"BigInt","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt","url":"\/documentation\/bigint","type":"topic","kind":"symbol","abstract":[{"text":"Signed integers and fractions of unbounded size","type":"text"}],"role":"collection"},"doc://bigint.BigInt/documentation/BigInt/Algorithms":{"role":"article","type":"topic","abstract":[{"type":"text","text":"Some of the algorithms used in BigInt are described below"}],"url":"\/documentation\/bigint\/algorithms","title":"Algorithms","kind":"article","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/Algorithms"},"doc://bigint.BigInt/documentation/BigInt/AboutBFraction":{"role":"article","type":"topic","abstract":[{"type":"text","text":"Signed fractions with numerator and denominator of unbounded size"}],"url":"\/documentation\/bigint\/aboutbfraction","title":"About BFraction","kind":"article","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/AboutBFraction"},"doc://bigint.BigInt/documentation/BigInt/Performance":{"role":"article","title":"Performance","kind":"article","type":"topic","abstract":[{"type":"text","text":"Execution times for certain BigInt operations"}],"url":"\/documentation\/bigint\/performance","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/Performance"}}}

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/!=(_:_:)-608h1"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/bigint.BigInt\/documentation\/BigInt","doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction","doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/Equatable-Implementations"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bigint\/bfraction\/!=(_:_:)-608h1"]}],"metadata":{"roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","extendedModule":"Swift","symbolKind":"op","modules":[{"relatedModules":["Swift"],"name":"BigInt"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:6BigInt9BFractionV","title":"!=(_:_:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"references":{"doc://bigint.BigInt/documentation/BigInt/BFraction/Equatable-Implementations":{"title":"Equatable Implementations","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/Equatable-Implementations","kind":"article","role":"collectionGroup","abstract":[],"type":"topic","url":"\/documentation\/bigint\/bfraction\/equatable-implementations"},"doc://bigint.BigInt/documentation/BigInt/BFraction/!=(_:_:)-608h1":{"url":"\/documentation\/bigint\/bfraction\/!=(_:_:)-608h1","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/!=(_:_:)-608h1","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","abstract":[],"title":"!=(_:_:)","kind":"symbol"},"doc://bigint.BigInt/documentation/BigInt":{"title":"BigInt","abstract":[{"text":"Signed integers and fractions of unbounded size","type":"text"}],"kind":"symbol","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt","role":"collection","type":"topic","url":"\/documentation\/bigint"},"doc://bigint.BigInt/documentation/BigInt/BFraction":{"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BFraction"}],"abstract":[{"text":"The BFraction structure","type":"text"}],"title":"BFraction","type":"topic","url":"\/documentation\/bigint\/bfraction","navigatorTitle":[{"text":"BFraction","kind":"identifier"}],"role":"symbol"}}}
{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bigint\/bfraction\/!=(_:_:)-608h1"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/bigint.BigInt\/documentation\/BigInt","doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction","doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/Equatable-Implementations"]]},"identifier":{"url":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/!=(_:_:)-608h1","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","symbolKind":"op","extendedModule":"Swift","role":"symbol","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:6BigInt9BFractionV","modules":[{"relatedModules":["Swift"],"name":"BigInt"}],"roleHeading":"Operator"},"references":{"doc://bigint.BigInt/documentation/BigInt/BFraction/Equatable-Implementations":{"title":"Equatable Implementations","url":"\/documentation\/bigint\/bfraction\/equatable-implementations","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/Equatable-Implementations","kind":"article","type":"topic"},"doc://bigint.BigInt/documentation/BigInt/BFraction/!=(_:_:)-608h1":{"type":"topic","url":"\/documentation\/bigint\/bfraction\/!=(_:_:)-608h1","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","abstract":[],"kind":"symbol","role":"symbol","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction\/!=(_:_:)-608h1"},"doc://bigint.BigInt/documentation/BigInt":{"title":"BigInt","identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt","url":"\/documentation\/bigint","type":"topic","kind":"symbol","abstract":[{"text":"Signed integers and fractions of unbounded size","type":"text"}],"role":"collection"},"doc://bigint.BigInt/documentation/BigInt/BFraction":{"kind":"symbol","title":"BFraction","abstract":[{"type":"text","text":"The BFraction structure"}],"identifier":"doc:\/\/bigint.BigInt\/documentation\/BigInt\/BFraction","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"BFraction"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BFraction","kind":"identifier"}],"url":"\/documentation\/bigint\/bfraction"}}}

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading

0 comments on commit 8eff157

Please sign in to comment.