Merge pull request #4 from HechtiDerLachs/julie_yun

Add first file for documentation.

docs/doc.main

@@ -212,6 +212,9 @@
       "Combinatorics/graphs.md",
       "Combinatorics/matroids.md",
       "Combinatorics/simplicialcomplexes.md",
+      "Combinatorics/partitions.md",
+      "Combinatorics/tableaux.md",
+      "Combinatorics/schur_polynomials.md",
   ],
 
   "Straight Line Programs" => [

docs/src/Combinatorics/partitions.md

@@ -0,0 +1,36 @@
+# Partitions
+
+```@docs
+    Partition
+```
+
+## Unrestricted partitions
+
+```@docs
+    partitions(::Integer)
+    num_partitions(::Integer)
+    ascending_partitions
+```
+
+## Restricted partitions
+
+```@docs
+    partitions(::Integer, ::Integer, ::Integer, ::Integer)
+    partitions(::Integer, ::Integer)
+    num_partitions(::Integer, ::Integer)
+    partitions(::Array{Integer,1}, ::Integer, ::Array{Integer,1}, ::Integer)
+```
+
+## Operations
+
+```@docs
+    conjugate
+    getindex_safe
+```
+
+## Relations
+
+```@docs
+    dominates
+```
+

docs/src/Combinatorics/schur_polynomials.md

@@ -0,0 +1,5 @@
+# Schur polynomials
+
+```@docs
+    schur_polynomial(lambda::Partition{T}, n=sum(lambda)::Int) where T<:Integer
+```

docs/src/Combinatorics/tableaux.md

@@ -0,0 +1,33 @@
+# Tableaux
+
+```@docs
+Tableau
+```
+
+## Operations
+
+```@docs
+hook_length
+hook_lengths
+shape
+weight
+reading_word
+```
+
+## Semistandard tableaux
+
+```@docs
+is_semistandard
+semistandard_tableaux
+```
+
+## Standard tableaux
+
+```@docs
+is_standard
+standard_tableaux
+num_standard_tableaux
+schensted
+bump!
+```
+

experimental/JuLie/partitions.jl

@@ -2,6 +2,9 @@
 # Partitions.
 #
 # Copyright (C) 2020 Ulrich Thiel, ulthiel.com/math
+#
+# Originally taken from the JuLie [repository](https://github.com/ulthiel/JuLie)
+# by Ulrich Thiel and OSCAR-ified by Claudia He Yun and Matthias Zach.
 ################################################################################
 
 export Partition, partitions, ascending_partitions, dominates, conjugate, getindex_safe, num_partitions

experimental/JuLie/schur_polynomials.jl

@@ -2,6 +2,9 @@
 # Schur Polynomials
 #
 # Copyright (C) 2020 Ulrich Thiel, ulthiel.com/math
+#
+# Originally taken from the JuLie [repository](https://github.com/ulthiel/JuLie)
+# by Ulrich Thiel and OSCAR-ified by Claudia He Yun and Matthias Zach.
 ################################################################################
 
 export schur_polynomial
@@ -288,4 +291,4 @@ function schur_polynomial_combinat(R::FmpzMPolyRing, lambda::Partition{T}, k=sum
 	m = len
 	n = lambda[len]
 	end #while true
-end
+end

experimental/JuLie/tableaux.jl

@@ -2,6 +2,9 @@
 # Tableaux
 #
 # Copyright (C) 2020 Ulrich Thiel, ulthiel.com/math
+#
+# Originally taken from the JuLie [repository](https://github.com/ulthiel/JuLie)
+# by Ulrich Thiel and OSCAR-ified by Claudia He Yun and Matthias Zach.
 ################################################################################
 
 export Tableau, shape, semistandard_tableaux, is_standard, is_semistandard, standard_tableaux, schensted, hook_length, hook_lengths, num_standard_tableaux, reading_word, weight, bump!
@@ -678,4 +681,4 @@ function bump!(Tab::Tableau, x::Integer, Q::Tableau, y::Integer)
 	push!(Q.t, [y])
 
 	return Tab,Q
-end
+end