promoteFromMap doc

pzinn · Oct 6, 2024 · 30fe092 · 30fe092
1 parent 92b9dcd
commit 30fe092
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/M2/Macaulay2/packages/Macaulay2Doc/functions/promoteFromMap-doc.m2 b/M2/Macaulay2/packages/Macaulay2Doc/functions/promoteFromMap-doc.m2
@@ -0,0 +1,26 @@
+--- status: DRAFT
+--- author(s): PZJ
+--- notes: 
+
+undocumented {(promoteFromMap,Ring,Ring)}
+
+doc ///
+ Key
+  promoteFromMap
+ Headline
+  automatic promotion from one ring to another
+ Usage
+  promoteFromMap f
+ Inputs
+  f: RingMap
+ Description
+  Text
+   After calling @TT "promoteFromMap"@, any operation that is given an element of the source of @TT "f"@ but
+   expects an elements of the target of @TT "f"@ will automatically apply @TT "f"@.
+  Example
+   R=QQ[x_1,x_2]
+   R'=QQ[e_1,e_2]
+   promoteFromMap map(R,R',{x_1+x_2,x_1*x_2})
+   e_1*x_1
+   e_2==x_1*x_2
+///