1 (* Title: src/Tools/isac/BridgeJEdit/VSCode_Example.thy
2 Author: Walther Neuper, JKU Linz
3 (c) due to copyright terms
5 Runnig example for developing Isabelle/Isac via Isabelle/PIDE in BridgeJEdit.
6 File will go to test/Tools/isac/BridgeJEdit/VSCode_Example.thy
7 compare test/Tools/isac/BridgeJEdit/vscode-example.sml
14 section \<open>Boilerplate, the example for Isabelle Workshop 2022\<close>
16 subsection \<open>Specification Phase\<close>
17 text \<open>Goal for Isabelle Workshop 2022: this part of the example should be ready for demonstration:
18 1. The keyword \<open>Example\<close> inserts the template underneath
19 2. The template is filled from a (hidden) formalisation with the following items in the
20 2.1. \<open>Model\<close>:
21 * Constants _ ("_" indicates some kind of place holder for input)
22 * the complete Where-field (the pre-condition), items marked as True | False
23 * Maximum _, AdditionalValues _
24 * Extremum _, SideCondition _
25 2.2 \<open>References\<close>:
26 * place holders "_" for input
27 * The toggle switch before \<open>Problem_Ref\<close> | \<open>Method_Ref\<close> is set to \<open>Problem_Ref\<close>
28 This might be postponed after the Isabelle Workshop.
30 * type checked and marked as Type-Error
31 * marked as Correct | Superfluous | Incomplete | Unknown (compare Specify/p-model.sml)
32 4. Input to 2.2 by selection from a list / tree
33 5. On update of \<open>Problem_Ref\<close> (in the root problem) also \<open>Problem\<close> is updated;
34 The argument of \<open>Problem\<close> comes with the template and is read-only.
36 The specific representation of the Demo_Example demonstrate different situations
37 in educational settings.
40 subsubsection \<open>Complete Specification\<close>
42 * This is one correct result of interactive Specification.
43 * Or this might be presented to the student in one go in order to start Solution immediately
44 (and nevertheless make the Specification explicit)
45 Note that \<open>Problem "univariate_calculus/Optimisation"\<close> and
46 \<open>Problem_Ref: "univariate_calculus/Optimisation"\<close> are redundant; the latter is for input,
47 the former is given initially and needs to be updated in accordance to \<open>Problem_Ref\<close>.
49 text \<open> (*.. remove as soon as this works as Isabelle/Isar commands ..*)
51 Example "Diff_App/No.123 a"
52 Problem "univariate_calculus/Optimisation"
55 Given: \<open>Constants r = 7\<close>
56 Where: \<open>0 < r\<close>
57 Find: \<open>Maximum A\<close> \<open>AdditionalValues u, v\<close>
58 Relate: \<open>Extremum A = 2 \<sqdot> u \<sqdot> v − u \<up> 2\<close> \<open>SideCondition (u / 2) \<up> 2 + (2 / v) \<up> 2 = r \<up> 2\<close>
60 Theory_Ref: "Diff_App"
61 \<Otimes> Problem_Ref: "univariate_calculus/Optimisation"
62 \<Odot> Method_Ref: "Optimisation/by_univariate_calculus"
65 (* remove as soon as this ^^^ works as Isabelle/Isar commands ..*) \<close>
67 subsubsection \<open>Empty Specification\<close>
69 This is presented to the student in one go in order to start interactive Specification.
71 text \<open> (*.. remove as soon as this works as Isabelle/Isar commands ..*)
73 Example "Diff_App/No.123 a"
77 Given: \<open>Constants _\<close>
78 Where: \<open>0 < r\<close>
79 Find: \<open>Maximum _\<close> \<open>AdditionalValues _\<close>
80 Relate: \<open>Extremum _\<close> \<open>SideCondition _\<close>
83 \<Otimes> Problem_Ref: "_/_"
84 \<Odot> Method_Ref: "_/_"
87 (* remove as soon as this ^^^ works as Isabelle/Isar commands ..*) \<close>
89 subsubsection \<open>Plain Example\<close>
91 This can occur in between text offering to start an interactive Calculation by using
92 "Diff_App/No.123 a" as a link.
94 text \<open> (*.. remove as soon as this works as Isabelle/Isar commands ..*)
96 Example "Diff_App/No.123 a"
98 (* remove as soon as this ^^^ works as Isabelle/Isar commands ..*) \<close>
100 subsubsection \<open>Immediate Start of Interactive Solving\<close>
102 This is requested by teachers in case of CAS_Cmd, e.g. "solve (x+1=2, x)"
103 where Specification usually is not interesting to students
104 and thus done automatically by ISAC in the background.
106 text \<open> (*.. remove as soon as this works as Isabelle/Isar commands ..*)
108 Example "Diff_App/No.123 a"
109 Problem "univariate_calculus/Optimisation"
113 (* remove as soon as this ^^^ works as Isabelle/Isar commands ..*) \<close>
115 subsubsection \<open>Show the Model associated to Method_Ref\<close>
117 The Model of a method usually comprises more items than the model of a Problem: all these
118 are required to run the program such that it automatically generates a Solution. For instance,
119 compare \<open>problem pbl_bieg\<close> and \<open>method met_biege_2\<close> in \<open>Biegelinie.thy\<close>
120 (TODO: method/program for \<open>Problem "univariate_calculus/Optimisation"\<close>)
121 The Model of a method is usually called a guard.
123 text \<open> (*.. remove as soon as this works as Isabelle/Isar commands ..*)
125 Example "Diff_App/No.123 a"
126 Problem "univariate_calculus/Optimisation"
129 Given: \<open>Constants r = 7\<close>
130 Where: \<open>0 < r\<close>
131 Find: \<open>Maximum A\<close> \<open>AdditionalValues u, v\<close>
132 Relate: \<open>Extremum A = 2 \<sqdot> u \<sqdot> v − u \<up> 2\<close> \<open>SideCondition (u / 2) \<up> 2 + (2 / v) \<up> 2 = r \<up> 2\<close>
134 Theory_Ref: "Diff_App"
135 \<Odot> Problem_Ref: "univariate_calculus/Optimisation"
136 \<Otimes> Method_Ref: "Optimisation/by_univariate_calculus"
139 (* remove as soon as this ^^^ works as Isabelle/Isar commands ..*) \<close>
142 section \<open>Stepwise Development\<close>
144 subsection \<open>preparing VSCode_Example\<close>
146 (**** preparing VSCode_Example ########################################################### ****)
147 "----------- preparing VSCode_Example ----------------------------------------------------------";
148 "----------- preparing VSCode_Example ----------------------------------------------------------";
149 \<close> text \<open>
150 --- maximum example with Step.specify_do_next --- from test/../step.sml
153 "fixedValues [r=Arbfix]", "maximum A",
154 "valuesFor [a,b::real]",
155 "relations [A=a*(b::real), (a/2) \<up> 2 + (b/2) \<up> 2 = (r::real) \<up> 2]",
156 "relations [A=a*(b::real), (a/2) \<up> 2 + (b/2) \<up> 2 = (r::real) \<up> 2]",
157 "relations [A=a*(b::real), a/2=r*sin alpha, b/2 = (r::real)*cos (alpha::real)]",
159 "boundVariable a", "boundVariable b", "boundVariable alpha",
160 "interval {x::real. 0 <= x & x <= 2*r}",
161 "interval {x::real. 0 <= x & x <= 2*r}",
162 "interval {x::real. 0 <= x & x <= pi}",
163 "errorBound (eps=(0::real))"];
165 ("Diff_App", ["maximum_of", "function"], ["Diff_App", "max_by_calculus"]);
166 \<close> text \<open>
167 from paper "Towards Accessible Formal Mathematics with ISAC and Isabelle/VSCode"
169 F_I \<equiv> [ [r = 7], [A, [u, v]], [A = 2 * u * v - u \<up> 2 , ( 2 / u ) \<up> 2 + ( 2 / v ) \<up> 2 = r \<up> 2], {0 <..< r} ]
170 --- type conflict ^^ ----------^^
171 F_II \<equiv> [ [r = 7], [A, \<alpha>], [A = 2 * u * v - u \<up> 2 , u / 2 = r * sin \<alpha>, 2 / v = r * cos \<alpha>], {0 <..< \<pi> / 2} ]
175 "Constants [r = (7::real)]", "Maximum A", "AdditionalValues [u, v]",
176 "Extremum (A = 2 * u * v - u \<up> 2)",
177 "SideConditions [((u::real) / 2) \<up> 2 + (2 / v) \<up> 2 = r \<up> 2]",
178 "SideConditions [((u::real) / 2) \<up> 2 + (2 / v) \<up> 2 = r \<up> 2]",
179 "SideConditions [(u::real) / 2 = r * sin \<alpha>, 2 / v = r * cos \<alpha>]",
181 "FunctionVariable a", "FunctionVariable b", "FunctionVariable \<alpha>",
184 "Domain {0 <..< \<pi> / 2}",
185 "ErrorBound (\<epsilon> = (0::real))"
186 ]: TermC.as_string list;
188 ("Diff_App", ["univariate_calculus", "Optimisation"], ["Optimisation", "by_univariate_calculus"]);
192 subsection \<open>Specification Phase\<close>
194 Stepwise development of \<open>Outer_Syntax.command \<^command_keyword>\<open>Example\<close>\<close> begins with
195 the changeset https://hg.risc.uni-linz.ac.at/wneuper/isa/rev/9d98791b4080
198 The intermediate steps below will be deleted as soon as all above representations
199 of Example "Diff_App/No.123 a" work out.
202 subsubsection \<open>Complete Specification at once\<close>
203 Example "Diff_App/No.123 a"
204 Problem "univariate_calculus/Optimisation"
207 Given: \<open>Constants [r = 7]\<close>
208 Where: \<open>0 < r\<close>
209 Find: \<open>Maximum A\<close> \<open>AdditionalValues [u, v]\<close>
210 Relate: \<open>Extremum A = 2 * u * v - u \<up> 2\<close>
211 \<open>SideConditions [((u::real) / 2) \<up> 2 + (2 / v) \<up> 2 = r \<up> 2]\<close>
214 Theory_Ref: "Diff_App"
215 (*\<Odot>*) Problem_Ref: "univariate_calculus/Optimisation"
216 (*\<Otimes>*) Method_Ref: "Optimisation/by_univariate_calculus"
219 val state = the_data @{theory}; (* state filled from the above Example by \<open>fun update_state\<close> *)
221 val (o_model, refs, _) = Ctree.get_obj Ctree.g_origin state []
222 val problem_model = Ctree.get_obj Ctree.g_pbl state []
223 val method_model = Ctree.get_obj Ctree.g_met state []
224 \<close> text \<open> (* this was with Specify.finish_phasePIDE in init_ctree, cf. 28da4f69d32d *)
225 if length o_model = 12 andalso refs =
226 ("Diff_App", ["univariate_calculus", "Optimisation"], ["Optimisation", "by_univariate_calculus"])
227 andalso length problem_model = 5 andalso length method_model = 8
228 then () else error "initialised state CHANGED";
230 if length o_model = 12 andalso refs =
231 ("Diff_App", ["univariate_calculus", "Optimisation"], ["Optimisation", "by_univariate_calculus"])
232 andalso length problem_model = 0 andalso length method_model = 0
233 then () else error "initialised state CHANGED";
237 subsubsection \<open>Specification step by step\<close>