From c8ddf8f6796ebcce5ab7e67314af943ced7c6063 Mon Sep 17 00:00:00 2001
From: Vasily Vasinov <des.elyon@gmail.com>
Date: Mon, 30 Sep 2019 12:06:47 -0600
Subject: [PATCH] Replace overridden `toString` methods with `toHumanString`

---
 src/main/scala/scotty/quantum/State.scala        | 2 +-
 src/main/scala/scotty/quantum/StateReader.scala  | 8 ++++----
 src/main/scala/scotty/quantum/gate/Gate.scala    | 2 +-
 src/main/scala/scotty/quantum/math/Complex.scala | 2 +-
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/main/scala/scotty/quantum/State.scala b/src/main/scala/scotty/quantum/State.scala
index 5514ee8..bd4b004 100644
--- a/src/main/scala/scotty/quantum/State.scala
+++ b/src/main/scala/scotty/quantum/State.scala
@@ -18,7 +18,7 @@ case class Superposition(register: QubitRegister, state: Vector) extends State {
     if (state.length == 0) sp
     else ctx.tensorProduct(register, this, sp)
 
-  override def toString: String = s"Superposition(${state.toList})"
+  def toHumanString: String = s"Superposition(${state.toList})"
 }
 
 case class Collapsed(register: QubitRegister, index: Int) extends State {
diff --git a/src/main/scala/scotty/quantum/StateReader.scala b/src/main/scala/scotty/quantum/StateReader.scala
index 702bd5c..39351ae 100644
--- a/src/main/scala/scotty/quantum/StateReader.scala
+++ b/src/main/scala/scotty/quantum/StateReader.scala
@@ -21,7 +21,7 @@ case class StateProbabilityReader(state: State)(implicit ctx: QuantumContext) ex
     case c: Collapsed => Seq(StateData(c.toBinary, Complex(1), 1))
   }
 
-  override def toString: String = read.flatMap(p => {
+  def toHumanString: String = read.flatMap(p => {
     val prob = p.probability.toPercent
 
     if (prob == 0) None
@@ -55,7 +55,7 @@ case class QubitProbabilityReader(register: Option[QubitRegister], state: State)
 
   def read(label: String): Option[QubitData] = read.find(q => q.label.contains(label))
 
-  override def toString: String = read.map(_.toString).mkString("\n")
+  def toHumanString: String = read.map(_.toString).mkString("\n")
 }
 
 object QubitProbabilityReader {
@@ -67,7 +67,7 @@ object QubitProbabilityReader {
   case class QubitData(label: Option[String], index: Int, probabilityOfOne: Double) {
     val probabilityOfZero: Double = 1 - probabilityOfOne
 
-    override def toString: String = {
+    def toHumanString: String = {
       val probZero = probabilityOfZero.toPercent
       val probOne = probabilityOfOne.toPercent
 
@@ -105,7 +105,7 @@ case class BlochSphereReader(state: State)(implicit ctx: QuantumContext) extends
       Array(BlochSphereData(phi, theta, Coordinates(x, y, z)))
   }
 
-  override def toString: String = {
+  def toHumanString: String = {
     val state = read(0)
     val phi = Math.toDegrees(state.phi)
     val theta = Math.toDegrees(state.theta)
diff --git a/src/main/scala/scotty/quantum/gate/Gate.scala b/src/main/scala/scotty/quantum/gate/Gate.scala
index 70764aa..7e4c0ff 100644
--- a/src/main/scala/scotty/quantum/gate/Gate.scala
+++ b/src/main/scala/scotty/quantum/gate/Gate.scala
@@ -27,7 +27,7 @@ trait TargetGate extends Gate {
 
   def matrix: Matrix = matrixGen.apply(params)
 
-  override def toString: String = matrix.toList.map(_.toList.mkString(" ")).mkString("\n")
+  def toHumanString: String = matrix.toList.map(_.toList.mkString(" ")).mkString("\n")
 }
 
 trait ControlGate extends Gate {
diff --git a/src/main/scala/scotty/quantum/math/Complex.scala b/src/main/scala/scotty/quantum/math/Complex.scala
index 35c0ad9..acc2c6c 100644
--- a/src/main/scala/scotty/quantum/math/Complex.scala
+++ b/src/main/scala/scotty/quantum/math/Complex.scala
@@ -3,7 +3,7 @@ package scotty.quantum.math
 import scotty.quantum.QuantumContext.{Matrix, Vector}
 
 case class Complex(r: Float, i: Float) {
-  override def toString: String = Complex.toString(this)
+  def toHumanString: String = Complex.toString(this)
 }
 
 object Complex {