Merge pull request #3183 from JacquesCarette/Issue3162

Implement vector + and -

code/Makefile

@@ -161,7 +161,8 @@ SUMMARIZE_TEX=no
 
 # Some commands now prefer to have TERM defined when things go awry
 # and since this is going to be run in batch, 'dumb' is best default.
-TERM=dumb
+# But don't set TERM itself, as it will make things ugly for interactive use.
+BATCHTERM=dumb
 
 ########################
 #--- Actual targets ---#
@@ -314,7 +315,7 @@ $(filter %$(STABILIZE_E_SUFFIX), $(STABILIZE_EXAMPLES)): %$(STABILIZE_E_SUFFIX):
 %$(TEX_E_SUFFIX): EXAMPLE=$(shell echo $* | tr a-z A-Z)
 %$(TEX_E_SUFFIX): EDIR=$($(EXAMPLE)_DIR)
 $(filter %$(TEX_E_SUFFIX), $(TEX_EXAMPLES)): %$(TEX_E_SUFFIX): %$(TRACE_GRAPH_SUFFIX)
-	EDIR="$(EDIR)" BUILD_FOLDER="$(BUILD_FOLDER)" SUMMARIZE_TEX=$(SUMMARIZE_TEX) MAKE="$(MAKE)" TERM="$(TERM)" "$(SHELL)" "$(SCRIPT_FOLDER)"tex_build.sh
+	EDIR="$(EDIR)" BUILD_FOLDER="$(BUILD_FOLDER)" SUMMARIZE_TEX=$(SUMMARIZE_TEX) MAKE="$(MAKE)" TERM="$(BATCHTERM)" "$(SHELL)" "$(SCRIPT_FOLDER)"tex_build.sh
 
 #----------------------------------------------------------------------------------#
 #--- Generate analysis of module, class, datatype, and class instance structure ---#

code/drasil-code-base/lib/Language/Drasil/Code/Expr.hs

@@ -31,8 +31,8 @@ data LABinOp = Index
 data OrdBinOp = Lt | Gt | LEq | GEq
   deriving Eq
 
--- | @Vector x Vector -> Vector@ binary operations (cross product).
-data VVVBinOp = Cross
+-- | @Vector x Vector -> Vector@ binary operations (cross product, vector addition, vector sub).
+data VVVBinOp = Cross | VAdd | VSub
   deriving Eq
 
 -- | @Vector x Vector -> Number@ binary operations (dot product).
@@ -304,6 +304,11 @@ instance ExprC CodeExpr where
   -- | Smart constructor to cross product two expressions.
   cross = VVVBinaryOp Cross
 
+  -- | Adding vectors
+  vAdd  = VVVBinaryOp VAdd
+  -- | Subtracting vectors
+  vSub  = VVVBinaryOp VSub
+
   -- | Smart constructor for case statements with a complete set of cases.
   completeCase = Case Complete
 

code/drasil-code-base/lib/Language/Drasil/Code/Expr/Convert.hs

@@ -83,6 +83,8 @@ ordBinOp LD.GEq = GEq
 
 vvvBinOp :: LD.VVVBinOp -> VVVBinOp
 vvvBinOp LD.Cross = Cross
+vvvBinOp LD.VAdd = VAdd
+vvvBinOp LD.VSub = VSub
 
 vvnBinOp :: LD.VVNBinOp -> VVNBinOp
 vvnBinOp LD.Dot = Dot

code/drasil-code/lib/Language/Drasil/Code/Imperative/Import.hs

@@ -453,6 +453,8 @@ ordBfunc GEq = (?>=)
 -- Maps a 'VVVBinOp' to it's corresponding GOOL binary function.
 vecVecVecBfunc :: VVVBinOp -> (SValue r -> SValue r -> SValue r)
 vecVecVecBfunc Cross = error "bfunc: Cross not implemented"
+vecVecVecBfunc VAdd = error "bfunc: Vector addition not implemented"
+vecVecVecBfunc VSub = error "bfunc: Vector subtraction not implemented"
 
 -- Maps a 'VVNBinOp' to it's corresponding GOOL binary function.
 vecVecNumBfunc :: VVNBinOp -> (SValue r -> SValue r -> SValue r)

code/drasil-example/gamephysics/lib/Drasil/GamePhysics/DataDefs.hs

@@ -249,7 +249,7 @@ reVelInColl :: SimpleQDef
 reVelInColl = mkQuantDef initRelVel reVelInCollEqn
 
 reVelInCollEqn :: Expr
-reVelInCollEqn = sy velAP $- sy velBP
+reVelInCollEqn = sy velAP `vSub` sy velBP
 
 reVelInCollDesc :: Sentence
 reVelInCollDesc = foldlSent [S "In a collision, the", phraseNP (QP.velocity

code/drasil-example/gamephysics/lib/Drasil/GamePhysics/Unitals.hs

@@ -252,10 +252,12 @@ forcej = ucs' (dccWDS "forcej" (compoundPhrase'
 
 velAP = ucs' (dccWDS "v^AP" (compoundPhrase' (QP.velocity ^. term)
               (cn "of the point of collision P in body A")) 
-              (phrase QP.velocity)) (sup (eqSymb QP.velocity)(Concat [lBodyA, lPoint])) Real velU
+              (phrase QP.velocity)) (sup (eqSymb QP.velocity)(Concat [lBodyA, lPoint])) 
+              (Vect Real) velU
 velBP = ucs' (dccWDS "v^BP" (compoundPhrase' (QP.velocity ^. term)
               (cn "of the point of collision P in body B")) 
-              (phrase QP.velocity)) (sup (eqSymb QP.velocity)(Concat [lBodyB, lPoint])) Real velU
+              (phrase QP.velocity)) (sup (eqSymb QP.velocity)(Concat [lBodyB, lPoint]))
+              (Vect Real) velU
 
 force_1    = forceParam "1" "first"  label1
 force_2    = forceParam "2" "second" label2

code/drasil-lang/lib/Language/Drasil/Expr/Class.hs

@@ -195,6 +195,12 @@ class ExprC r where
   -- | Smart constructor for vector scaling
   vScale :: r -> r -> r
 
+  -- | Vector Addition
+  vAdd :: r -> r -> r
+
+  -- | Vector Subtraction
+  vSub :: r -> r -> r
+
   -- | Smart constructor for case statements with a complete set of cases.
   completeCase :: [(r, r)] -> r
 
@@ -365,6 +371,10 @@ instance ExprC Expr where
 
   -- | Smart constructor to cross product two expressions.
   cross = VVVBinaryOp Cross
+  -- | Adding vectors
+  vAdd  = VVVBinaryOp VAdd
+  -- | Subtracting vectors
+  vSub  = VVVBinaryOp VSub
 
   -- | Smart constructor for case statements with a complete set of cases.
   completeCase = Case Complete
@@ -535,6 +545,11 @@ instance ExprC M.ModelExpr where
   -- | Smart constructor to cross product two expressions.
   cross = M.VVVBinaryOp M.Cross
 
+  -- | Adding vectors
+  vAdd  = M.VVVBinaryOp M.VAdd
+  -- | Subtracting vectors
+  vSub  = M.VVVBinaryOp M.VSub
+
   -- | Smart constructor for case statements with a complete set of cases.
   completeCase = M.Case Complete
 

code/drasil-lang/lib/Language/Drasil/Expr/Lang.hs

@@ -46,8 +46,8 @@ data LABinOp = Index
 data OrdBinOp = Lt | Gt | LEq | GEq
   deriving Eq
 
--- | @Vector x Vector -> Vector@ binary operations (cross product).
-data VVVBinOp = Cross
+-- | @Vector x Vector -> Vector@ binary operations (cross product, addition, subtraction).
+data VVVBinOp = Cross | VAdd | VSub
   deriving Eq
 
 -- | @Vector x Vector -> Number@ binary operations (dot product).
@@ -193,6 +193,16 @@ instance Eq Expr where
 --   fromRational r = ArithBinaryOp Frac (fromInteger $ numerator   r)
 --                                       (fromInteger $ denominator r)
 
+-- Helper class for pretty-printing errors (should move from here)
+-- We don't want to (ab)use Show for this
+class Pretty p where
+  pretty :: p -> String
+
+instance Pretty VVVBinOp where
+  pretty Cross = "cross product"
+  pretty VAdd  = "vector addition"
+  pretty VSub  = "vector subtraction"
+
 instance LiteralC Expr where
   int = Lit . int
   str = Lit . str
@@ -206,6 +216,19 @@ assocArithOperToTy MulI  = S.Integer
 assocArithOperToTy AddRe = S.Real
 assocArithOperToTy MulRe = S.Real
 
+-- helper function for typechecking to help reduce duplication
+vvvInfer :: TypingContext Space -> VVVBinOp -> Expr -> Expr -> Either Space TypeError
+vvvInfer ctx op l r = case (infer ctx l, infer ctx r) of
+    (Left lt@(S.Vect lsp), Left (S.Vect rsp)) -> 
+      if lsp == rsp && S.isBasicNumSpace lsp then
+        if op == VSub && (lsp == S.Natural || rsp == S.Natural) then
+          Right $ "Vector subtraction expects both operands to be vectors of non-natural numbers. Received `" ++ show lsp ++ "` and `" ++ show rsp ++ "`."
+        else Left lt
+      else Right $ "Vector " ++ pretty op ++ " expects both operands to be vectors of non-natural numbers. Received `" ++ show lsp ++ "` and `" ++ show rsp ++ "`."
+    (Left lsp, Left rsp) -> Right $ "Vector operation " ++ pretty op ++ " expects vector operands. Received `" ++ show lsp ++ "` and `" ++ show rsp ++ "`."
+    (_       , Right re) -> Right re
+    (Right le, _       ) -> Right le
+
 instance Typed Expr Space where
   check :: TypingContext Space -> Expr -> Space -> Either Space TypeError
   check = typeCheckByInfer
@@ -340,12 +363,14 @@ instance Typed Expr Space where
     (_, Right re) -> Right re
     (Right le, _) -> Right le
 
-  infer cxt (VVVBinaryOp Cross l r) = case (infer cxt l, infer cxt r) of
+  infer cxt (VVVBinaryOp o l r) = vvvInfer cxt o l r
+    {- case (infer cxt l, infer cxt r) of
     (Left lTy, Left rTy) -> if lTy == rTy && S.isBasicNumSpace lTy && lTy /= S.Natural
       then Left lTy
       else Right $ "Vector cross product expects both operands to be vectors of non-natural numbers. Received `" ++ show lTy ++ "` X `" ++ show rTy ++ "`."
     (_       , Right re) -> Right re
     (Right le, _       ) -> Right le
+    -}
 
   infer cxt (VVNBinaryOp Dot l r) = case (infer cxt l, infer cxt r) of
     (Left lt@(S.Vect lsp), Left rt@(S.Vect rsp)) -> if lsp == rsp && S.isBasicNumSpace lsp

code/drasil-lang/lib/Language/Drasil/ModelExpr/Convert.hs

@@ -70,6 +70,8 @@ ordBinOp E.GEq = GEq
 
 vvvBinOp :: E.VVVBinOp -> VVVBinOp
 vvvBinOp E.Cross = Cross
+vvvBinOp E.VAdd = VAdd
+vvvBinOp E.VSub = VSub
 
 vvnBinOp :: E.VVNBinOp -> VVNBinOp
 vvnBinOp E.Dot = Dot

code/drasil-lang/lib/Language/Drasil/ModelExpr/Lang.hs

@@ -34,8 +34,8 @@ data LABinOp = Index
 data OrdBinOp = Lt | Gt | LEq | GEq
   deriving Eq
 
--- | @Vector x Vector -> Vector@ binary operations (cross product).
-data VVVBinOp = Cross
+-- | @Vector x Vector -> Vector@ binary operations (cross product, vector addition, subtraction).
+data VVVBinOp = Cross | VAdd | VSub
   deriving Eq
 
 -- | @Vector x Vector -> Number@ binary operations (dot product).

code/drasil-printers/lib/Language/Drasil/HTML/Print.hs

@@ -209,6 +209,8 @@ pOps Dim      = "dim"
 pOps Exp      = "e"
 pOps Neg      = "−"
 pOps Cross    = "⨯"
+pOps VAdd     = "+"
+pOps VSub     = "−"
 pOps Dot      = "⋅"
 pOps Scale    = " " -- same as Mul
 pOps Eq       = " = " -- with spaces?

code/drasil-printers/lib/Language/Drasil/JSON/Print.hs

@@ -153,6 +153,8 @@ pOps Dim      = "dim"
 pOps Exp      = "e"
 pOps Neg      = "-"
 pOps Cross    = "⨯"
+pOps VAdd     = " + "
+pOps VSub     = " - "
 pOps Dot      = "⋅"
 pOps Scale    = "" -- same as Mul
 pOps Eq       = " = " -- with spaces?

code/drasil-printers/lib/Language/Drasil/Plain/Print.hs

@@ -145,6 +145,8 @@ opsDoc Dim = text "dim"
 opsDoc Exp = text "exp"
 opsDoc Neg = text "-"
 opsDoc Cross = text " cross "
+opsDoc VAdd = text " + "
+opsDoc VSub = text " - "
 opsDoc Dot = text " dot "
 opsDoc Scale = text " * "
 opsDoc Eq = text " == "

code/drasil-printers/lib/Language/Drasil/Printing/AST.hs

@@ -12,6 +12,7 @@ data Ops = IsIn | Integer | Real | Rational | Natural | Boolean | Comma | Prime
   | Ln | Sin | Cos | Tan | Sec | Csc | Cot | Arcsin | Arccos | Arctan | Not
   | Dim | Exp | Neg | Cross | Dot | Scale | Eq | NEq | Lt | Gt | LEq | GEq | Impl | Iff
   | Subt | And | Or | Add | Mul | Summ | Inte | Prod | Point | Perc | LArrow | RArrow | ForAll
+  | VAdd | VSub
 
 -- | Holds the type of "text fencing" ("(), {}, |, ||").
 data Fence = Paren | Curly | Norm | Abs

code/drasil-printers/lib/Language/Drasil/Printing/Import/CodeExpr.hs

@@ -162,6 +162,8 @@ codeExpr (OrdBinaryOp LEq a b)    sm = mkBOp sm P.LEq a b
 codeExpr (OrdBinaryOp GEq a b)    sm = mkBOp sm P.GEq a b
 codeExpr (VVNBinaryOp Dot a b)    sm = mkBOp sm P.Dot a b
 codeExpr (VVVBinaryOp Cross a b)  sm = mkBOp sm P.Cross a b
+codeExpr (VVVBinaryOp VAdd a b)   sm = mkBOp sm P.VAdd a b
+codeExpr (VVVBinaryOp VSub a b)   sm = mkBOp sm P.VSub a b
 codeExpr (NVVBinaryOp Scale a b)  sm = mkBOp sm P.Scale a b
 codeExpr (Operator o d e)         sm = eop sm o d e
 codeExpr (RealI c ri)             sm = renderRealInt sm (lookupC (sm ^. stg)

code/drasil-printers/lib/Language/Drasil/Printing/Import/Expr.hs

@@ -158,6 +158,8 @@ expr (OrdBinaryOp Gt a b)     sm = mkBOp sm P.Gt a b
 expr (OrdBinaryOp LEq a b)    sm = mkBOp sm P.LEq a b
 expr (OrdBinaryOp GEq a b)    sm = mkBOp sm P.GEq a b
 expr (VVVBinaryOp Cross a b)  sm = mkBOp sm P.Cross a b
+expr (VVVBinaryOp VAdd a b)   sm = mkBOp sm P.VAdd a b
+expr (VVVBinaryOp VSub a b)   sm = mkBOp sm P.VSub a b
 expr (VVNBinaryOp Dot a b)    sm = mkBOp sm P.Dot a b
 expr (NVVBinaryOp Scale a b)  sm = mkBOp sm P.Scale a b
 expr (Operator o d e)         sm = eop sm o d e

code/drasil-printers/lib/Language/Drasil/Printing/Import/ModelExpr.hs

@@ -174,6 +174,8 @@ modelExpr (OrdBinaryOp LEq a b)      sm = mkBOp sm P.LEq a b
 modelExpr (OrdBinaryOp GEq a b)      sm = mkBOp sm P.GEq a b
 modelExpr (VVNBinaryOp Dot a b)      sm = mkBOp sm P.Dot a b
 modelExpr (VVVBinaryOp Cross a b)    sm = mkBOp sm P.Cross a b
+modelExpr (VVVBinaryOp VAdd a b)     sm = mkBOp sm P.VAdd a b
+modelExpr (VVVBinaryOp VSub a b)     sm = mkBOp sm P.VSub a b
 modelExpr (NVVBinaryOp Scale a b)    sm = mkBOp sm P.Scale a b
 modelExpr (Operator o d e)           sm = eop sm o d e
 modelExpr (RealI c ri)               sm = renderRealInt sm (lookupC (sm ^. stg)

code/drasil-printers/lib/Language/Drasil/TeX/Print.hs

@@ -147,6 +147,8 @@ pOps Dim      = command "mathsf" "dim"
 pOps Exp      = pure $ text "e"
 pOps Neg      = pure hyph
 pOps Cross    = texSym "times"
+pOps VAdd     = pure pls
+pOps VSub     = pure hyph -- unfortunately, hyphen and - are the same
 pOps Dot      = commandD "cdot" empty
 pOps Scale    = pure $ text " "
 pOps Eq       = pure assign