From 327c2a35bde7a13d77f343464e41e19e4a214790 Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Sat, 13 Oct 2018 15:51:53 -0400 Subject: General cleanup and documentation. Cleanup files, and add missing comments in places. --- base/src/main/java/bjc/utils/data/IPair.java | 67 ++++++++++++++++------------ 1 file changed, 39 insertions(+), 28 deletions(-) (limited to 'base/src/main/java/bjc/utils/data') diff --git a/base/src/main/java/bjc/utils/data/IPair.java b/base/src/main/java/bjc/utils/data/IPair.java index 907cf3d..886bf7c 100644 --- a/base/src/main/java/bjc/utils/data/IPair.java +++ b/base/src/main/java/bjc/utils/data/IPair.java @@ -12,10 +12,10 @@ import bjc.utils.funcdata.theory.Bifunctor; * @author ben * * @param - * The type of the left side of the pair. + * The type of the left side of the pair. * * @param - * The type of the right side of the pair. + * The type of the right side of the pair. * */ public interface IPair extends Bifunctor { @@ -23,13 +23,13 @@ public interface IPair extends Bifunctor - * The type of the bound left. + * The type of the bound left. * * @param - * The type of the bound right. + * The type of the bound right. * * @param binder - * The function to bind with. + * The function to bind with. * * @return The bound pair. */ @@ -40,10 +40,10 @@ public interface IPair extends Bifunctor - * The type of the bound value. + * The type of the bound value. * * @param leftBinder - * The function to use to bind. + * The function to use to bind. * * @return A pair with the left type bound. */ @@ -54,10 +54,10 @@ public interface IPair extends Bifunctor - * The type of the bound value. + * The type of the bound value. * * @param rightBinder - * The function to use to bind. + * The function to use to bind. * * @return A pair with the right type bound. */ @@ -68,13 +68,13 @@ public interface IPair extends Bifunctor - * The left type of the other pair. + * The left type of the other pair. * * @param - * The right type of the other pair. + * The right type of the other pair. * * @param otherPair - * The pair to combine with. + * The pair to combine with. * * @return The pairs, pairwise combined together. */ @@ -87,25 +87,25 @@ public interface IPair extends Bifunctor - * The type of the left value of the other pair. + * The type of the left value of the other pair. * * @param - * The type of the right value of the other pair. + * The type of the right value of the other pair. * * @param - * The type of the left value of the combined pair. + * The type of the left value of the combined pair. * * @param - * The type of the right value of the combined pair. + * The type of the right value of the combined pair. * * @param otherPair - * The other pair to combine with. + * The other pair to combine with. * * @param leftCombiner - * The function to combine the left values with. + * The function to combine the left values with. * * @param rightCombiner - * The function to combine the right values with. + * The function to combine the right values with. * * @return A pair with its values combined. */ @@ -119,7 +119,7 @@ public interface IPair extends Bifunctor consumer) { merge((leftValue, rightValue) -> { @@ -133,7 +133,7 @@ public interface IPair extends Bifunctor LeftBifunctorMap fmapLeft( final Function func) { return argumentPair -> { - if(!(argumentPair instanceof IPair)) { + if (!(argumentPair instanceof IPair)) { final String msg = "This function can only be applied to instances of IPair"; throw new IllegalArgumentException(msg); @@ -149,7 +149,7 @@ public interface IPair extends Bifunctor RightBifunctorMap fmapRight( final Function func) { return argumentPair -> { - if(!(argumentPair instanceof IPair)) { + if (!(argumentPair instanceof IPair)) { final String msg = "This function can only be applied to instances of IPair"; throw new IllegalArgumentException(msg); @@ -187,10 +187,11 @@ public interface IPair extends Bifunctor - * The new type of the left part of the pair. + * The new type of the left part of the pair. * * @param mapper - * The function to use to transform the left part of the pair. + * The function to use to transform the left part of the + * pair. * * @return The pair, with its left part transformed. */ @@ -202,10 +203,11 @@ public interface IPair extends Bifunctor - * The new type of the right part of the pair. + * The new type of the right part of the pair. * * @param mapper - * The function to use to transform the right part of the pair. + * The function to use to transform the right part of the + * pair. * * @return The pair, with its right part transformed. */ @@ -215,15 +217,24 @@ public interface IPair extends Bifunctor - * The type of the single value. + * The type of the single value. * * @param merger - * The function to use for merging. + * The function to use for merging. * * @return The pair, merged into a single value. */ public MergedType merge(BiFunction merger); + /** + * Static pair constructor. + * + * @param left + * The left side of the pair. + * @param right + * The right side of the pair. + * @return A pair, with the specified left/right side. + */ public static IPair pair(T1 left, T2 right) { return new Pair<>(left, right); } -- cgit v1.2.3 From d1d01769e7c55f7f62dc01cadf420d5f63424584 Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Sun, 14 Oct 2018 14:07:00 -0400 Subject: Testing --- .../main/java/bjc/utils/data/CircularIterator.java | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'base/src/main/java/bjc/utils/data') diff --git a/base/src/main/java/bjc/utils/data/CircularIterator.java b/base/src/main/java/bjc/utils/data/CircularIterator.java index 4558b63..9af4d87 100644 --- a/base/src/main/java/bjc/utils/data/CircularIterator.java +++ b/base/src/main/java/bjc/utils/data/CircularIterator.java @@ -8,7 +8,7 @@ import java.util.Iterator; * @author EVE * * @param - * The type of the iterable. + * The type of the iterable. */ public class CircularIterator implements Iterator { /* The iterable, and our current iterator into it. */ @@ -28,11 +28,11 @@ public class CircularIterator implements Iterator { * Create a new circular iterator. * * @param src - * The iterable to iterate from. + * The iterable to iterate from. * * @param circ - * Should we actually do circular iteration, or just repeat the - * terminal element? + * Should we actually do circular iteration, or just + * repeat the terminal element? */ public CircularIterator(final Iterable src, final boolean circ) { source = src; @@ -45,7 +45,7 @@ public class CircularIterator implements Iterator { * Create a new circular iterator that does actual circular iteration. * * @param src - * The iterable to iterate from. + * The iterable to iterate from. */ public CircularIterator(final Iterable src) { this(src, true); @@ -59,11 +59,12 @@ public class CircularIterator implements Iterator { @Override public E next() { - if(!curr.hasNext()) { - if(doCircle) { - curr = source.iterator(); - } else + if (!curr.hasNext()) { + if (!doCircle) { return curElm; + } + + curr = source.iterator(); } curElm = curr.next(); -- cgit v1.2.3