#4906: [with patch, needs review] convert sage.combinat.* docstrings to Sphinx
---------------------------+------------------------------------------------
Reporter: mhansen | Owner: tba
Type: defect | Status: new
Priority: major | Milestone: sage-3.4
Component: documentation | Keywords:
---------------------------+------------------------------------------------
Comment(by hivert):
I've been through the file from {{{alternating_sign_matrix.py}}}
to {{{sage/combinat/graph_path.py}}} in alphabetic order and from
{{{species/characteristic_species.py}}} to {{{yamanouchi.py}}}.
Here is my list of corrections:
{{{
File alternating_sign_matrix.py
===============================
* Function_next_column_iterator: typo
Returns a generator for all columbs of height height properly
columns
File choose_nk.py
=================
* function _comb_largest(a,b,x): The < are missing.
- Returns the largest w < a such that binomial(w,b) <= x.
+ Returns the largest w a such that binomial(w,b) = x.
File combinat.py
=================
In the web page, the Integrated patch about Bell's polynomial still
contains
latex command (Ticket #5109) in particular:
$$ B_{n,k}(x_1, x_2, ldots, x_{n-k+1}) = sum_{sum{j_i}=k, sum{i j_i} =n}
frac{n!}{j_1!j_2!ldots} frac{x_1}{1!}^j_1 frac{x_2}{2!}^j_2 ldots $$
* Function unordered_tuples: typo
+ An unordered tuple of length k of set is a unordered selection with
an
File composition.py
===================
The definition of Peak is wrong. This is the definition for permutations.
The peaks are the positions i in the compositions such that
- self[i-1] < self[i] > self[i+1]. Note that len(self)-1 is
- never a peak.
The peaks of a composition are the descents which does not imediately
follows
another descent. The function seems to be also completely wrong: in mupad
we
had:
>> compositions::peaks([1, 1, 3, 1, 2, 1, 3])
[5, 8]
File crystals.py
================
* class FastCrystal: The < are missing.
- integral. It is assumed that l1 >= l2 >= 0. If l1
+ integral. It is assumed that l1 = l2 = 0. If l1 and l2 are
* class CrystalOfTableaux: The < are missing.
- a partition of length <= type[1]. Produces a classical crystal with
+ partition of length = type[1]. Produces a classical crystal with
File designs/incidence_structures.py
====================================
* function block_design_checker: Misspelled argnument name:
- lmbda - each t-tuple of points should be incident with lmda
blocks
+ lmbda - each t-tuple of points should be incident with lmbda
blocks
* The doc after __init__ do not appear in the compiled doc. Is it normal ?
File dlx.py
===========
* In the doc all the matrices have been smashed eg:
- [
- [1, [i_11,i_12,...,i_1r]]
- ...
- [m, [i_m1,i_m2,...,i_ms]]
- ]
- where M[j][i_jk] = 1.
is now
[ [1, [i_11,i_12,...,i_1r]] ... [m,
+ [i_m1,i_m2,...,i_ms]] ] where M[j][i_jk] = 1.
And later on:
- 1110
- 1010
- 0100
- 0001
-
+
+ 1110 1010 0100 0001
+
This is no more readable.
* same remark on the code of _covercolumn:
* same remark on the code of _uncovercolumn:
file matrices/dlxcpp.p
======================
Same problem as dlx.py. (actually the doc is the same, there should be a
link
rather than a copy paste).
File free_module.py
===================
* function _apply_module_morphism: Strange quotes.
INPUT:
- -- x : a element of self
- -- f : a function that takes in a combinatorial object
+ - x : a element of self
+
+ -```` - f : a function that takes in a combinatorial
^^^^
File matrices/latin.py
======================
* The main doc seems to have been removed !!! :
-Latin squares
-
-A {\it latin square} of order $n$ is an $n \times n$ array such that
[... one page removed]
-TESTS:
- sage: L = elementary_abelian_2group(3)
- sage: L == loads(dumps(L))
- True
+Latin Squares
* function __init__: missing comparison sign : <
- at row r, column c is empty if and only if L[r, c] < 0. In this
+ if L[r, c] 0. In this way we allow partial latin squares and can
* function actual_row_col_sym_sizes: Please keep the brackets.
- {0, 1, ..., m} (no holes in that list).
+ 0, 1, ..., m (no holes in that list).
* function filled_cells_map: Please keep the braclets:
- Number the filled cells of self with integers from {1, 2, 3,
...}.
+ Number the filled cells of self with integers from 1, 2, 3, ....
File integer_list.py
====================
* function comp2floor: there is a missing arrow:
- Given a composition, returns the lowest regular function N->N above
+ Given a composition, returns the lowest regular function N-N above
* same in comp2ceil:
- Given a composition, returns the lowest regular function N->N below
+ Given a composition, returns the lowest regular function N-N below
File integer_vector.py
======================
* class class IntegerVectors_nnondescents: the itemize should be kept:
- The combinatorial class of integer vectors v graded by two
parameters:
- - n: the sum of the parts of v
- - comp: the non descents composition of v
+ The combinatorial class of integer vectors v graded by two
+ parameters: - n: the sum of the parts of v - comp: the non descents
+ composition of v
* missing arrow:
- maximal (for the natural left->right reading) in their orbit by the
+ maximal (for the natural left-right reading) in their orbit by the
File species/series.py:
=======================
def _power_gen(self): The exponent is missing
- Returns a generator for all the powers self^k starting with
+ Returns a generator for all the powers selfk starting with k = 1.
File species/structure.py
==========================
* Main doc: In the equation the "|" should not be lost !
-BB = o + o*BB + o*|*BB
+BB = o + o\*BB + o\*\*BB
File tableau.py
===============
* function descents: Missing comparison sign
- Returns a list of the boxes (i,j) such that
- self[i][j] > self[i-1][j].
+ Returns a list of the boxes (i,j) such that self[i][j]
+ self[i-1][j].
words/morphism.py
=================
* class WordMorphism: missing >
- Use the arrows ('->') correctly:
+ Use the arrows ('-') correctly::
words/suffix_trees.py
* function __init__: The presentation should be kept:
- function t is defined as
- t(-1,a) = 0 for all letters a; and
- t(x',a) = y' for all x',y' \in Q such that y = xa,
- and the suffix link function is defined as
- suffix_link(0) = -1;
- suffix_link(x') = y', if x = ay for some letter a.
+ purposes of the algorithm, there is also an auxiliary state -1.
The
+ transition function t is defined as t(-1,a) = 0 for all letters
a;
+ and t(x',a) = y' for all x',y' Q such that y = xa, and the suffix
+ link function is defined as suffix_link(0) = -1; suffix_link(x')
+ = y', if x = ay for some letter a.
* function _find_transition: the bracket should be kept (python code):
- ._transition_function = {..., node: {(i,j): target_node, ...}
}
+ ._transition_function = ..., node: (i,j): target_node, ...
words/word.py
=============
* function swap_increase: missing comparison sign:
- Returns the word with positions i and i+1 exchanged
- if self[i] > self[i+1]. Otherwise, it returns self.
+ Returns the word with positions i and i+1 exchanged if self[i]
+ self[i+1]. Otherwise, it returns self.
* same for function swap_decrease.
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4906#comment:12>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
