Project

General

Profile

Support #847

Doc for BigInt, BigIntOps, BigRat -- should there be BigRatOps?

Added by John Abbott about 8 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
John Abbott
Category:
Documentation
Target version:
CoCoALib-0.99600
Start date:
21 Mar 2016
Due date:
% Done:

100%

Estimated time:
7.70 h
Spent time:
7.70 h

Description

The doc for BigInt is split into two: BigInt and IntOperations (also some in NumTheory).

Currently the doc for BigRat is all inside BigRat (even some fns corresponding to those in IntOperations).

Reconsider this organization; either approve it explicitly, or rearrange it!

Related issues

Related to CoCoALib - Design #410: New file: BigRatOpsClosed2013-10-18

Related to CoCoALib - Design #1145: File names, coding conventions: Fns, Ops, Operations? part 2Closed2017-12-19

History

#1 Updated by John Abbott almost 8 years ago

  • Target version changed from CoCoALib-0.99550 spring 2017 to CoCoALib-0.99560

#2 Updated by John Abbott over 6 years ago

  • Target version changed from CoCoALib-0.99560 to CoCoALib-0.99600

#3 Updated by Anna Maria Bigatti almost 6 years ago

#4 Updated by Anna Maria Bigatti almost 6 years ago

Should it be BigIntOps?

#5 Updated by John Abbott almost 6 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 10

I like the name BigIntOps. The file does also contain several fns which accept MachineInt args (and several which allow arbitrary mixtures of BigInt and MachineInt), but this mostly just to offer a uniform interface independent of whether the caller has used a machine int or a big int.

The original question was about RatOperations, but that name should now be BigRatOps.

So the proposal now is the following:
  • rename IntOperations to BigIntOps
  • split BigRat into BigRat (just class defn, and maybe accessor fn) and BigRatOps (everything else currently in BigRat, parallelling what is (currently) in IntOperations)

Objections?

#6 Updated by Anna Maria Bigatti almost 6 years ago

Good!! go for it! :-)

#7 Updated by Anna Maria Bigatti almost 6 years ago

  • Related to Design #1145: File names, coding conventions: Fns, Ops, Operations? part 2 added

#8 Updated by Anna Maria Bigatti almost 6 years ago

  • Subject changed from Doc for BigInt, IntOperations, BigRat -- should there be RatOperations? to Doc for BigInt, IntOperations, BigRat -- should there be BigRatOps?

#9 Updated by Anna Maria Bigatti almost 6 years ago

  • Subject changed from Doc for BigInt, IntOperations, BigRat -- should there be BigRatOps? to Doc for BigInt, BigIntOps, BigRat -- should there be BigRatOps?

Renamed IntOperations into BigIntOps
(this should have been in #1145)

#10 Updated by John Abbott almost 6 years ago

  • Status changed from In Progress to Feedback
  • Assignee set to John Abbott
  • % Done changed from 10 to 90

I have split BigRat into BigRat (class defn, ctors, and accessors) and BigRatOps.
All files have been updated; all tests pass.
Any need to change the doc?

#11 Updated by Anna Maria Bigatti almost 6 years ago

John Abbott wrote:

I have split BigRat into BigRat (class defn, ctors, and accessors) and BigRatOps.
All files have been updated; all tests pass.
Any need to change the doc?

I think (nightmare?) that we should mention in the doc in which files (collectively, not for each function!) the class and functions are defined.

#12 Updated by John Abbott over 5 years ago

  • Status changed from Feedback to Closed
  • % Done changed from 90 to 100
  • Estimated time set to 7.70 h

The doc has already been split. Everything has worked fine for 2 months. Closing.

Also available in: Atom PDF