Update to documentation and refactoring

Author: Daniel Purtov

src/main/java/com/danielptv/simplex/entity/Phase.java

@@ -1,14 +1,14 @@
 package com.danielptv.simplex.entity;
 
 import com.danielptv.simplex.number.CalculableImpl;
-import com.danielptv.simplex.presentation.OutputUtils;
 import lombok.NonNull;
 
 import java.util.List;
 import java.util.stream.IntStream;
 
 import static com.danielptv.simplex.presentation.OutputUtils.FONT_GREEN;
 import static com.danielptv.simplex.presentation.OutputUtils.STYLE_RESET;
+import static com.danielptv.simplex.presentation.OutputUtils.accentuatePivot;
 
 /**
  * Entity-Class representing a phase of the Two-Phase-Simplex Method.
@@ -25,7 +25,7 @@ public record Phase<T extends CalculableImpl<T>>(
 ) {
 
     /**
-     * Method for getting the last table of the phase.
+     * Get the last table of the phase.
      *
      * @return The last table.
      */
@@ -36,7 +36,7 @@ public Table<T> getLastTable() {
     @Override
     public String toString() {
         IntStream.range(0, tables.size() - 1)
-                .forEach(i -> OutputUtils.accentuatePivot(tables.get(i)));
+                .forEach(i -> accentuatePivot(tables.get(i)));
 
         final var sb = new StringBuilder();
         sb.append("  ");

src/main/java/com/danielptv/simplex/entity/Row.java

@@ -57,9 +57,9 @@ public Row(@NonNull final Row<T> row) {
     }
 
     /**
-     * Method for inverting a Row.
+     * Invert a row.
      *
-     * @return The inverted Row.
+     * @return The inverted row.
      */
     public Row<T> invertRow() {
         return new Row<>(entries.stream()
@@ -68,11 +68,11 @@ public Row<T> invertRow() {
     }
 
     /**
-     * Method for multiplying a Row.
+     * Multiply a row.
      *
      * @param row    A row.
      * @param factor The factor.
-     * @return The multiplied Row.
+     * @return The multiplied row.
      */
     public Row<T> multiplyRow(@NonNull final Row<T> row, @NonNull final T factor) {
         return new Row<>(row.entries.stream()
@@ -81,10 +81,10 @@ public Row<T> multiplyRow(@NonNull final Row<T> row, @NonNull final T factor) {
     }
 
     /**
-     * Method for dividing a Row.
+     * Divide a row.
      *
      * @param divisor The divisor.
-     * @return The divided Row.
+     * @return The divided row.
      */
     public Row<T> divideRow(@NonNull final T divisor) {
         return new Row<>(entries.stream()
@@ -98,10 +98,10 @@ public Row<T> divideRow(@NonNull final T divisor) {
     }
 
     /**
-     * Method for adding two Rows.
+     * Add two rows.
      *
-     * @param addends A Row.
-     * @return The resulting Row.
+     * @param addends A row.
+     * @return The resulting row.
      */
     public Row<T> addRow(@NonNull final Row<T> addends) {
         if (addends.entries.size() != entries.size()) {
@@ -114,7 +114,7 @@ public Row<T> addRow(@NonNull final Row<T> addends) {
     }
 
     /**
-     * Method for adding a value to a Row.
+     * Add a value to a row.
      *
      * @param entry String representation of the value to be added.
      */
@@ -123,7 +123,7 @@ public void addVal(@NonNull final String entry) {
     }
 
     /**
-     * Method for determining if all entries are positive.
+     * Determine if all entries are positive.
      *
      * @return True if all entries are positive, else false.
      */
@@ -132,7 +132,7 @@ public boolean isPositive() {
     }
 
     /**
-     * Method for getting the index of the smallest value.
+     * Get the index of the smallest value.
      *
      * @return The index.
      */
@@ -142,7 +142,7 @@ public Integer getMinIndex() {
     }
 
     /**
-     * Method for getting an entry by its index.
+     * Get an entry by its index.
      *
      * @param index The index.
      * @return The entry.
@@ -172,7 +172,7 @@ public String toString() {
     }
 
     /**
-     * Method for setting the entry widths.
+     * Set the entry widths.
      */
     public void setEntryWidths() {
         entryWidths = new ArrayList<>(entries.stream().map(entry -> Math.max(entry.toString().length(), 2))

src/main/java/com/danielptv/simplex/entity/Table.java

@@ -12,29 +12,68 @@
  * @param inst          Instance of the number type to be calculated with.
  * @param title         Title of the table.
  * @param lHS           Left-hand side of the table.
- * @param extendedLHS   Extended left-hand side of the table.
  * @param rHS           Right-hand side of the table.
  * @param pivot         Pivot element.
  * @param columnHeaders Column headers.
  * @param rowHeaders    Row headers.
- * @param extensionSize Size of extended left-hand side.
+ * @param rows          Number of rows.
+ * @param columns       Total number of columns.
+ * @param helperColumns Number of helper columns.
  * @param <T>           Fraction or RoundedDecimal.
  */
 @SuppressWarnings("RecordComponentNumber")
 public record Table<T extends CalculableImpl<T>>(
         @NonNull T inst,
         @NonNull String title,
         @NonNull List<Row<T>> lHS,
-        List<Row<T>> extendedLHS,
         @NonNull List<T> rHS,
         @NonNull Pivot<T> pivot,
         @NonNull List<String> columnHeaders,
         @NonNull List<String> rowHeaders,
-        int extensionSize
+        int rows,
+        int columns,
+        int helperColumns
 ) {
+    /**
+     * Constructor for a table.
+     *
+     * @param inst          Instance of the number type to be calculated with.
+     * @param title         Title of the table.
+     * @param lHS           Left-hand side of the table.
+     * @param rHS           Right-hand side of the table.
+     * @param pivot         Pivot element.
+     * @param columnHeaders Column headers.
+     * @param rowHeaders    Row headers.
+     * @param helperColumns Number of helper columns.
+     */
+    @SuppressWarnings("ParameterNumber")
+    public Table(
+            @NonNull final T inst,
+            @NonNull final String title,
+            @NonNull final List<Row<T>> lHS,
+            @NonNull final List<T> rHS,
+            @NonNull final Pivot<T> pivot,
+            @NonNull final List<String> columnHeaders,
+            @NonNull final List<String> rowHeaders,
+            final int helperColumns
+    ) {
+        this(
+                inst,
+                title,
+                lHS,
+                rHS,
+                pivot,
+                columnHeaders,
+                rowHeaders,
+                lHS.size(),
+                lHS.get(0).getEntries().size(),
+                helperColumns
+        );
+
+    }
 
     /**
-     * Constructor for a Table.
+     * Copy-Constructor for a Table.
      *
      * @param table A Table.
      * @param title The new table title.
@@ -44,12 +83,13 @@ public Table(@NonNull final Table<T> table, @NonNull final String title) {
                 table.inst,
                 title,
                 table.lHS,
-                table.extendedLHS,
                 table.rHS,
                 table.pivot,
                 table.columnHeaders,
                 table.rowHeaders,
-                table.extensionSize
+                table.rows,
+                table.columns,
+                table.helperColumns
         );
     }
 

src/main/java/com/danielptv/simplex/number/CalculableImpl.java

@@ -9,54 +9,54 @@
  */
 public interface CalculableImpl<T extends CalculableImpl<T>> extends Comparable<T> {
     /**
-     * Method for multiplication.
+     * Multiply two values.
      *
      * @param c Fraction or RoundedDecimal.
      * @return Fraction or RoundedDecimal.
      */
     T multiply(T c);
 
     /**
-     * Method for division.
+     * Divide two values.
      *
      * @param c Fraction or RoundedDecimal.
      * @return Fraction or RoundedDecimal.
      */
     T divide(T c);
 
     /**
-     * Method for addition.
+     * Add two values.
      *
      * @param c Fraction or RoundedDecimal.
      * @return Fraction or RoundedDecimal.
      */
     T add(T c);
 
     /**
-     * Method for creating new Fraction or RoundedDecimal from an existing one.
+     * Create a new Fraction or RoundedDecimal from an existing one.
      *
      * @param s String representation of the number.
      * @return Fraction or RoundedDecimal.
      */
     T create(String s);
 
     /**
-     * Method for getting the value as BigDecimal.
+     * Get the value as BigDecimal.
      *
      * @return The value as BigDecimal.
      */
     BigDecimal toDecimal();
 
     /**
-     * Method for setting the value of a number to infinity.
+     * Set the value to infinity.
      *
      * @param infinityType Positive or negative infinity.
      * @return Infinity.
      */
     T toInfinity(InfinityType infinityType);
 
     /**
-     * Method for determining whether a number is infinite.
+     * Determine whether a value is infinite.
      *
      * @return True if infinite else false.
      */

src/main/java/com/danielptv/simplex/number/Fraction.java

@@ -90,7 +90,7 @@ private Fraction(@NonNull final InfinityType infinityType) {
     }
 
     /**
-     * Method for multiplying two Fractions.
+     * Multiply two Fractions.
      *
      * @param f A Fraction.
      * @return The multiplied Fraction.
@@ -101,7 +101,7 @@ public Fraction multiply(@NonNull final Fraction f) {
     }
 
     /**
-     * Method for dividing two Fractions.
+     * Divide two Fractions.
      *
      * @param f A Fraction.
      * @return The divided Fraction.
@@ -112,7 +112,7 @@ public Fraction divide(@NonNull final Fraction f) {
     }
 
     /**
-     * Method for adding two Fractions.
+     * Add two Fractions.
      *
      * @param f A Fraction.
      * @return The added Fraction.
@@ -124,7 +124,7 @@ public Fraction add(@NonNull final Fraction f) {
     }
 
     /**
-     * Method for creating a new Fraction from an existing one.
+     * Create a new Fraction from an existing one.
      *
      * @param s String representation of the number.
      * @return The new Fraction.
@@ -135,7 +135,7 @@ public Fraction create(@NonNull final String s) {
     }
 
     /**
-     * Method for getting the value as BigDecimal.
+     * Get the value as BigDecimal.
      *
      * @return The value as BigDecimal rounded to 2 decimal places.
      */
@@ -190,13 +190,6 @@ public String toString() {
         return numerator.abs() + "/" + denominator.abs();
     }
 
-    /**
-     * Method for simplifying Fractions.
-     *
-     * @param num   The numerator.
-     * @param denom The denominator.
-     * @return The simplified Fraction.
-     */
     private Pair<BigInteger, BigInteger> simplify(@NonNull final BigInteger num, @NonNull final BigInteger denom) {
 
         if (num.equals(new BigInteger("0"))) {
@@ -215,13 +208,6 @@ private Pair<BigInteger, BigInteger> simplify(@NonNull final BigInteger num, @No
         return result;
     }
 
-    /**
-     * Methode for determining the greatest common divider.
-     *
-     * @param num   The numerator.
-     * @param denom The denominator.
-     * @return The greatest common divider.
-     */
     private BigInteger gcd(@NonNull final BigInteger num, @NonNull final BigInteger denom) {
 
         var first = num.abs();