From df94066e3af02ff02d5ab4d033a3d603f743234c Mon Sep 17 00:00:00 2001
From: bjculkin <bjculkin@mix.wvu.edu>
Date: Mon, 12 Feb 2018 22:45:04 -0500
Subject: Formatting pass

---
 base/src/main/java/bjc/utils/data/IPair.java | 98 ++++++++++++----------------
 1 file changed, 43 insertions(+), 55 deletions(-)

(limited to 'base/src/main/java/bjc/utils/data/IPair.java')

diff --git a/base/src/main/java/bjc/utils/data/IPair.java b/base/src/main/java/bjc/utils/data/IPair.java
index 75b092d..1c864d1 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 <LeftType>
- * 	The type of the left side of the pair.
+ *        The type of the left side of the pair.
  *
  * @param <RightType>
- * 	The type of the right side of the pair.
+ *        The type of the right side of the pair.
  *
  */
 public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightType> {
@@ -23,16 +23,15 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Bind a function across the values in this pair.
 	 *
 	 * @param <BoundLeft>
-	 * 	The type of the bound left.
+	 *        The type of the bound left.
 	 *
 	 * @param <BoundRight>
-	 * 	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.
+	 * @return The bound pair.
 	 */
 	public <BoundLeft, BoundRight> IPair<BoundLeft, BoundRight> bind(
 			BiFunction<LeftType, RightType, IPair<BoundLeft, BoundRight>> binder);
@@ -41,13 +40,12 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Bind a function to the left value in this pair.
 	 *
 	 * @param <BoundLeft>
-	 * 	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.
+	 * @return A pair with the left type bound.
 	 */
 	public <BoundLeft> IPair<BoundLeft, RightType> bindLeft(
 			Function<LeftType, IPair<BoundLeft, RightType>> leftBinder);
@@ -56,13 +54,12 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Bind a function to the right value in this pair.
 	 *
 	 * @param <BoundRight>
-	 * 	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.
+	 * @return A pair with the right type bound.
 	 */
 	public <BoundRight> IPair<LeftType, BoundRight> bindRight(
 			Function<RightType, IPair<LeftType, BoundRight>> rightBinder);
@@ -71,16 +68,15 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Pairwise combine two pairs together.
 	 *
 	 * @param <OtherLeft>
-	 * 	The left type of the other pair.
+	 *        The left type of the other pair.
 	 *
 	 * @param <OtherRight>
-	 * 	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.
+	 * @return The pairs, pairwise combined together.
 	 */
 	public default <OtherLeft, OtherRight> IPair<IPair<LeftType, OtherLeft>, IPair<RightType, OtherRight>> combine(
 			final IPair<OtherLeft, OtherRight> otherPair) {
@@ -91,28 +87,27 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Combine the contents of two pairs together.
 	 *
 	 * @param <OtherLeft>
-	 * 	The type of the left value of the other pair.
+	 *        The type of the left value of the other pair.
 	 *
 	 * @param <OtherRight>
-	 *	The type of the right value of the other pair.
+	 *        The type of the right value of the other pair.
 	 *
 	 * @param <CombinedLeft>
-	 * 	The type of the left value of the combined pair.
+	 *        The type of the left value of the combined pair.
 	 *
 	 * @param <CombinedRight>
-	 * 	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.
+	 * @return A pair with its values combined.
 	 */
 	public <OtherLeft, OtherRight, CombinedLeft, CombinedRight> IPair<CombinedLeft, CombinedRight> combine(
 			IPair<OtherLeft, OtherRight> otherPair,
@@ -124,7 +119,7 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * pair.
 	 *
 	 * @param consumer
-	 * 	The action to perform on the pair.
+	 *        The action to perform on the pair.
 	 */
 	public default void doWith(final BiConsumer<LeftType, RightType> consumer) {
 		merge((leftValue, rightValue) -> {
@@ -135,10 +130,10 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	}
 
 	@Override
-	default <OldLeft, OldRight, NewLeft> LeftBifunctorMap<OldLeft, OldRight, NewLeft>
-			fmapLeft(final Function<OldLeft, NewLeft> func) {
+	default <OldLeft, OldRight, NewLeft> LeftBifunctorMap<OldLeft, OldRight, NewLeft> fmapLeft(
+			final Function<OldLeft, NewLeft> 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);
@@ -151,10 +146,10 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	}
 
 	@Override
-	default <OldLeft, OldRight, NewRight> RightBifunctorMap<OldLeft, OldRight, NewRight> 
-			fmapRight(final Function<OldRight, NewRight> func) {
+	default <OldLeft, OldRight, NewRight> RightBifunctorMap<OldLeft, OldRight, NewRight> fmapRight(
+			final Function<OldRight, NewRight> 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);
@@ -169,8 +164,7 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	/**
 	 * Get the value on the left side of the pair.
 	 *
-	 * @return
-	 * 	The value on the left side of the pair.
+	 * @return The value on the left side of the pair.
 	 */
 	@Override
 	public default LeftType getLeft() {
@@ -180,8 +174,7 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	/**
 	 * Get the value on the right side of the pair.
 	 *
-	 * @return
-	 * 	The value on the right side of the pair.
+	 * @return The value on the right side of the pair.
 	 */
 	@Override
 	public default RightType getRight() {
@@ -189,19 +182,17 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	}
 
 	/**
-	 * Transform the value on the left side of the pair. 
+	 * Transform the value on the left side of the pair.
 	 *
 	 * Doesn't modify the pair.
 	 *
 	 * @param <NewLeft>
-	 * 	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.
+	 * @return The pair, with its left part transformed.
 	 */
 	public <NewLeft> IPair<NewLeft, RightType> mapLeft(Function<LeftType, NewLeft> mapper);
 
@@ -211,14 +202,12 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Doesn't modify the pair.
 	 *
 	 * @param <NewRight>
-	 * 	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.
+	 * @return The pair, with its right part transformed.
 	 */
 	public <NewRight> IPair<LeftType, NewRight> mapRight(Function<RightType, NewRight> mapper);
 
@@ -226,13 +215,12 @@ public interface IPair<LeftType, RightType> extends Bifunctor<LeftType, RightTyp
 	 * Merge the two values in this pair into a single value.
 	 *
 	 * @param <MergedType>
-	 * 	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.
+	 * @return The pair, merged into a single value.
 	 */
 	public <MergedType> MergedType merge(BiFunction<LeftType, RightType, MergedType> merger);
 }
-- 
cgit v1.2.3