src/Tools/isac/TODO.thy
author Walther Neuper <walther.neuper@jku.at>
Sat, 30 May 2020 15:20:22 +0200
changeset 60011 25e6810ca0e7
parent 60002 0073ca6530bb
child 60015 77c0abec88fa
permissions -rw-r--r--
cleanup code after resolve hacks
neuper@42314
     1
(* Title:  todo's for isac core
neuper@42314
     2
   Author: Walther Neuper 111013
neuper@42314
     3
   (c) copyright due to lincense terms.
neuper@42314
     4
*)
wneuper@59504
     5
theory TODO
wneuper@59504
     6
imports "~~/src/Doc/Prog_Prove/LaTeXsugar"
wneuper@59504
     7
begin
neuper@42314
     8
walther@59779
     9
text \<open>
walther@59779
    10
Legend: here + code since 200120
walther@59779
    11
  \<open>(*DOC\<close> identifies stuff dedicated for isac/Doc/Lucas_Interpreter
walther@59779
    12
  \<open>(*?!?\<close> identifies a design question
walther@59779
    13
walther@59779
    14
Distillation of "rounds of reforms":
walther@59779
    15
  \<open>TODOs from current changesets\<close> \<rightarrow> \<open>Postponed from current changeset\<close> \<rightarrow>
walther@59779
    16
  (*to be removed..*) \<rightarrow> \<open>Separated tasks\<close> (*.. to be removed*)
walther@59779
    17
  \<rightarrow> subsection of \<open>Major reforms\<close>
walther@59779
    18
\<close>
walther@59779
    19
wneuper@59574
    20
section \<open>TODOs from current changesets\<close>
wneuper@59568
    21
text\<open>
walther@59779
    22
  Shift more complicated issues from  \<open>Current changeset\<close> to \<open>Postponed from current changeset\<close>
wneuper@59568
    23
\<close>
wneuper@59574
    24
subsection \<open>Current changeset\<close>
wneuper@59574
    25
text \<open>
walther@59938
    26
(*/------- to  from -------\*)
walther@59938
    27
(*\------- to  from -------/*)
wneuper@59569
    28
  \begin{itemize}
walther@59927
    29
  \item xxx
walther@60011
    30
  \item unify code
walther@60011
    31
    at all occurrences of O_Model.complete_for
walther@60011
    32
  \item xxx
walther@60011
    33
  \item simplify code
walther@60011
    34
    find_next_step
walther@60011
    35
    remove find_next_step' (used only for p_)
walther@60011
    36
  \item xxx
walther@60011
    37
  \item LibraryC.distinct shadows Library.distinct (+ see Library.member)
walther@59998
    38
  \item xxx
walther@59998
    39
  \item Specify.find_next_step: References.select
walther@59998
    40
    cpI = ["vonBelastungZu", "Biegelinien"]: References_Def.id
walther@59998
    41
                                      ^^^^^  Problem.id
walther@59998
    42
  \item xxx
walther@59998
    43
  \item Calc.state_empty_post \<rightarrow> Calc.state_post_empty
walther@59998
    44
  \item xxx
walther@59986
    45
  \item distribute code from test/../calchead.sml
walther@59986
    46
  \item xxx
walther@59935
    47
  \item rename Tactic.Calculate -> Tactic.Evaluate
walther@59779
    48
  \item xxx
walther@59923
    49
  \item replace src/ Erls by Rule_Set.Empty
walther@59882
    50
  \item xxx
walther@59882
    51
  \item rename ptyps.sml -> specify-etc.sml
walther@59882
    52
        rename Specify -> Specify_Etc
walther@59976
    53
        rename Specify -> Specify
walther@59842
    54
  \item xxx
walther@59914
    55
  \item specific_from_prog in..end: replace o by |> (Test_Isac or Test_Some!)
walther@59914
    56
  \item xxx
walther@59914
    57
  \item cleanup ThmC in MathEngBasic
walther@59914
    58
  \item xxx
walther@59914
    59
  \item xxx
walther@59914
    60
  \item xxx
walther@59842
    61
  \item xxx
walther@59842
    62
  \item xxx
walther@59842
    63
  \item xxx
walther@59842
    64
  \item xxx
walther@59842
    65
  \item xxx
walther@59846
    66
  \end{itemize}
walther@59846
    67
\<close>
walther@59846
    68
subsection \<open>Postponed from current changeset\<close>
walther@59846
    69
text \<open>
walther@59886
    70
  \begin{itemize}
walther@59886
    71
  \item xxx
walther@60002
    72
  \item unify code Specify.find_next_step <--> Step_Specify.by_tactic (Tactic.Specify_Method'
walther@60002
    73
  \item xxx
walther@59998
    74
  \item Isa20.implementation: 0.2.4 Printing ML values ?INSTEAD? *.TO_STRING ???
walther@59998
    75
    ??? writeln ( make_string {x = x, y = y}); ???
walther@59998
    76
  \item xxx
walther@59953
    77
  \item revise O_Model and I_Model with an example with more than 1 variant.
walther@59953
    78
  \item xxx
walther@59944
    79
  \item ctxt is superfluous in specify-phase due to type constraints from Descript.thy
walther@59944
    80
  \item xxx
walther@59934
    81
  \item Derive.do_one: TODO find code in common with complete_solve
walther@59934
    82
        Derive.embed: TODO rewrite according to CAO (+ no intermediate access to Ctree)
walther@59934
    83
  \item xxx
walther@59930
    84
  \item Solve_Check: postponed parsing input to _ option
walther@59930
    85
  \item xxx
walther@59921
    86
  \item ? "fetch-tactics.sml" from Mathengine -> BridgeLibisabelle ?
walther@59886
    87
  \item xxx
walther@59921
    88
  \item ? unify struct.Step and struct.Solve in MathEngine ?
walther@59851
    89
  \item xxx
walther@59919
    90
  \item use "Eval_Def" for renaming identifiers
walther@59851
    91
  \item xxx
walther@59886
    92
  \item why does Test_Build_Thydata.thy depend on ProgLang and not on CalcElements ?
walther@59851
    93
  \item xxx
walther@59851
    94
  \item xxx
walther@59846
    95
  \begin{itemize}
walther@59846
    96
  \item LI.do_next (*TODO RM..*) ???
walther@59846
    97
  \item generate.sml: RM datatype edit TOGETHER WITH datatype inout
walther@59846
    98
  \item TermC.list2isalist: typ -> term list -> term  .. should NOT requires typ
walther@59846
    99
  \item get_ctxt_LI should replace get_ctxt
walther@59846
   100
  \item ALL CODE: rename spec(ification) --> know(ledge), in Specification: Relation -> Knowledge
walther@59846
   101
  \item rename   Base_Tool.thy  <---         Base_Tools
walther@59846
   102
  \item adopt naming conventions in Knowledge: EqSystem --> Equation_System, etc
walther@59846
   103
  \item rename field scr in meth
walther@59820
   104
  \item DEL double code: nxt_specify_init_calc IN specify.sml + step-specify.sml
walther@59819
   105
  \item xxx
walther@59820
   106
  \item xxx
walther@59820
   107
  \item xxx
walther@59844
   108
  \item xxx
walther@59844
   109
  \item xxx
walther@59844
   110
  \item xxx
walther@59817
   111
  \item xxx
walther@59814
   112
  \item clarify Tactic.Subproblem (domID, pblID) as term in Pstate {act_arg, ...}
walther@59848
   113
     there it is Free ("Subproblem", "char list \<times> ..
walther@59848
   114
     instead of  Const (|???.Subproblem", "char list \<times> ..
walther@59848
   115
     AND THE STRING REPRESENTATION IS STRANGE: 
walther@59848
   116
       Subproblem (''Test'',
walther@59848
   117
        ??.\ <^const> String.char.Char ''LINEAR'' ''univariate'' ''equation''
walther@59848
   118
         ''test'')
walther@59814
   119
     ML \<open>
walther@59814
   120
     \<close> ML \<open>
walther@59814
   121
     term2str; (*defined by..*)
walther@59814
   122
     fun term_to_string''' thy t =
walther@59814
   123
       let
walther@59814
   124
         val ctxt' = Config.put show_markup false (Proof_Context.init_global thy)
walther@59814
   125
       in Print_Mode.setmp [] (Syntax.string_of_term ctxt') t end;
walther@59814
   126
     \<close> ML \<open>
walther@59814
   127
     val t = @{term "aaa + bbb"}
walther@59814
   128
     val t = @{term "Subproblem (''Test'', [''LINEAR'', ''univariate'', ''equation''])"};
walther@59814
   129
     \<close> ML \<open>
walther@59814
   130
     val sss = Print_Mode.setmp [] (Syntax.string_of_term @{context}) t
walther@59814
   131
     \<close> ML \<open>
walther@59814
   132
     writeln sss (*.. here perfect: Subproblem (''Test'', [''LINEAR'', ''univariate'', ''equation'']) *)
walther@59814
   133
     \<close> ML \<open>
walther@59814
   134
     \<close>
walther@59814
   135
  \item xxx
walther@59814
   136
  \item xxx
walther@59814
   137
  \item cleanup fun me:
walther@59814
   138
    fun me (*(_, Empty_Tac) p _ _ = raise ERROR ("me:  Empty_Tac at " ^ pos'2str p)
walther@59814
   139
      | me*) (_, tac) p _(*NEW remove*) pt =
walther@59814
   140
    + -------------------------^^^^^^
walther@59814
   141
    # see test-code.sml fun me_trace
walther@59814
   142
      use this also for me, not only for me_ist_ctxt; del. me
walther@59814
   143
      this requires much updating in all test/*
walther@59802
   144
  \item xxx
walther@59779
   145
  \item shift tests into NEW model.sml (upd, upds_envv, ..)
walther@59779
   146
  \item xxx
walther@59814
   147
  \item clarify handling of contexts ctxt ContextC
walther@59779
   148
    \begin{itemize}
walther@59779
   149
    \item xxx
walther@59779
   150
    \item Specify/ works with thy | Interpret/ works with ctxt | MathEngine.step works with ?!?ctxt
walther@59779
   151
    \item xxx
walther@59779
   152
    \item Check_Elementwise "Assumptions": prerequisite for ^^goal
walther@59779
   153
      rm tactic Check_elementwise "Assumptions" in a way, which keeps it for Minisubpbl
walther@59779
   154
      rm Assumptions  :: bool  (* TODO: remove with making ^^^ idle *)
walther@59779
   155
    \item xxx
walther@59779
   156
    \item xxx
walther@59779
   157
    \end{itemize}
walther@59779
   158
  \item xxx
walther@59779
   159
  \item xxx
walther@59779
   160
  \item complete mstools.sml (* survey on handling contexts:
walther@59779
   161
  \item xxx
walther@59779
   162
  \item xxx
walther@59779
   163
  \item xxx
walther@59779
   164
  \item xxx
walther@59779
   165
  \item librarys.ml --> libraryC.sml + text from termC.sml
walther@59779
   166
  \item xxx
walther@59779
   167
  \item xxx
walther@59779
   168
  \item xxx
walther@59779
   169
  \item xxx
walther@59779
   170
  \item xxx
walther@59779
   171
  \item xxx
walther@59779
   172
  \item concentrate "insert_assumptions" for locate_input_tactic in "associate", ?OR? Tactic.insert_assumptions
walther@59779
   173
                                   DONE  for find_next_step by Tactic.insert_assumptions m' ctxt 
walther@59779
   174
    \begin{itemize}
walther@59779
   175
    \item rm from "generate1" ("Detail_Set_Inst'", Tactic.Detail_Set' ?)
walther@59779
   176
    \item ?"insert_assumptions" necessary in "init_pstate" ?+++? in "applicable_in" ?+++? "associate"
walther@59779
   177
    \item xxx
walther@59779
   178
    \item xxx
walther@59779
   179
    \item DO DELETIONS AFTER analogous concentrations in find_next_step
walther@59779
   180
    \end{itemize}
walther@59779
   181
  \item xxx
walther@59779
   182
  \item ? what is the difference headline <--> cascmd in
walther@59779
   183
    Subproblem' (spec, oris, headline, fmz_, context, cascmd)
walther@59924
   184
  \item Substitute' what does "re-calculation mean in the datatype comment?
walther@59779
   185
  \item xxx
walther@59881
   186
  \item inform: TermC.parse (ThyC.get_theory "Isac_Knowledge") istr --> parseNEW context istr
walther@59799
   187
  \item xxx
walther@59816
   188
  \item unify/clarify stac2tac_ | 
walther@59779
   189
    \begin{itemize}
walther@59779
   190
    \item xxx
walther@59816
   191
    \item extract common code from associate.. stac2tac_xxx
walther@59823
   192
    \item rename LItool.tac_from_prog -> Tactic.from_prog_tac ? Solve_Tac.from_prog_tac,
walther@59779
   193
    \item xxx
walther@59779
   194
    \item xxx
walther@59779
   195
    \end{itemize}
walther@59779
   196
  \item xxx
walther@59779
   197
  \item unify in signature LANGUAGE_TOOLS =\\
walther@59903
   198
    val pblterm: ThyC.id -> Problem.id -> term     vvv        vvv\\
walther@59779
   199
    val subpbl: string -> string list -> term          unify with ^^^
walther@59779
   200
  \item xxx
walther@59779
   201
  \item Telem.safe is questionable: has it been replaced by Safe_Step, Not_Derivable, Helpless, etc?
walther@59779
   202
    Note: replacement of Istate.safe by Istate.appy_ didn't care much about Telem.safe.
walther@59779
   203
    If Telem.safe is kept, consider merge with CTbasic.ostate
walther@59779
   204
  \item xxx
walther@59779
   205
  \item remove find_next_step from solve Apply_Method';
walther@59779
   206
    this enforces Pos.at_first_tactic, which should be dropped, too.
walther@59779
   207
  \item xxx
walther@59779
   208
  \item xxx
walther@59816
   209
  \item xxx
walther@59779
   210
  \end{itemize}
walther@59779
   211
\<close>
walther@59851
   212
subsection \<open>Postponed --> Major reforms\<close>
walther@59816
   213
text \<open>
walther@59816
   214
  \begin{itemize}
walther@59816
   215
  \item xxx          
walther@59846
   216
  \item revisit bootstrap Calcelements. rule->calcelems->termC
walther@59868
   217
    would be nice, but is hard: UnparseC.terms -> TermC.s_to_string
walther@59820
   218
  \item xxx
walther@59820
   219
  \item replace all Ctree.update_* with Ctree.cupdate_problem
walther@59820
   220
  \item xxx
walther@59816
   221
  \item rename (ist as {eval, ...}) -> (ist as {eval_rls, ...})
walther@59816
   222
  \item xxx
walther@59816
   223
  \item exception PROG analogous to TERM
walther@59816
   224
  \item xxx
walther@59816
   225
  \item sig/struc ..elems --> ..elem
walther@59816
   226
  \item xxx          
walther@59816
   227
  \item distille CAS-command, CAScmd, etc into a struct
walther@59816
   228
  \item xxx          
walther@59816
   229
  \item check location of files:
walther@59816
   230
        test/Tools/isac/Interpret/ptyps.thy
walther@59816
   231
        test/Tools/isac/Specify.ptyps.sml
walther@59816
   232
  \item xxx
walther@59816
   233
  \item check occurences of Atools in src/ test/
walther@59816
   234
  \item Const ("Atools.pow", _) ---> Const ("Base_Tool.pow", _) 
walther@59816
   235
  \item xxx          
walther@59816
   236
  \item rm Float
walther@59816
   237
  \item xxx
walther@59816
   238
  \item Diff.thy: differentiateX --> differentiate after removal of script-constant
walther@59816
   239
  \item Test.thy: met_test_sqrt2: deleted?!
walther@59816
   240
  \item xxx          
walther@59887
   241
  \item Rewrite_Ord.rew_ord' := overwritel (! Rewrite_Ord.rew_ord', (*<<<---- use Know_Store.xxx, too*)
walther@59816
   242
  \item xxx
walther@59816
   243
    \item automatically extrac rls from program-code 
walther@59816
   244
      ? take ["SignalProcessing", "Z_Transform", "Inverse_sub"] as an example ?
walther@59816
   245
  \item xxx          
walther@59901
   246
  \item finish output of LItool.trace with Check_Postcond (useful for SubProblem)
walther@59816
   247
  \item xxx
walther@59851
   248
  \item replace Rule_Set.empty by Rule_Set.Empty
walther@59851
   249
    latter is more clear, but replacing ***breaks rewriting over all examples***,
walther@59851
   250
    e.g. see ERROR: rewrite__set_ called with 'Erls' for 'precond_rootpbl x'
walther@59851
   251
    in Minisubplb/200-start-method-NEXT_STEP.sml:
walther@59851
   252
     (*+* )------- in f3cac3053e7b (Rule_Set.empty just renamed, NOT deleted) we had
walther@59851
   253
     (*+*)  prls =
walther@59852
   254
     (*+*)    Rls {calc = [], erls = Erls, errpatts = [], id = "empty", preconds = [], rew_ord =
walther@59878
   255
     (*+*)      ("dummy_ord", fn), rules = [], scr = Empty_Prog, srls = Erls}:
walther@59851
   256
     (*+*).. THIS IS Rule_Set.empty, BUT IT DID not CAUSE ANY ERROR !
walther@59851
   257
     (*+*)------- WITH Rule_Set.empty REMOVED (based on f3cac3053e7b) we had
walther@59851
   258
     (*+*)val Empty = prls (* <---ERROR: rewrite__set_ called with 'Erls' for 'precond_rootpbl x' *)
walther@59851
   259
     ( *+*)val ["sqroot-test", "univariate", "equation", "test"] = cpI
walther@59851
   260
    THAT INDICATES, that much rewriting/evaluating JUST WORKED BY CHANCE?!?
walther@59816
   261
  \item xxx          
walther@59816
   262
  \item xxx
walther@59816
   263
  \item xxx          
walther@59816
   264
  \item xxx
walther@59816
   265
  \item xxx          
walther@59816
   266
  \item xxx
walther@59816
   267
  \item xxx          
walther@59816
   268
  \end{itemize}
walther@59816
   269
\<close>
walther@59816
   270
walther@59779
   271
section \<open>Major reforms\<close>
walther@59779
   272
text \<open>
walther@59779
   273
\<close>
walther@59779
   274
subsection \<open>Exception Size raised\<close>
walther@59779
   275
text \<open>
walther@59779
   276
  During update Isabelle2018 --> Isabelle2019 we noticed, that
walther@59779
   277
  "isabelle build" uses resources more efficiently than "isabelle jedit".
walther@59779
   278
  The former works, but the latter causes 
walther@59779
   279
  \begin{itemize}
walther@59779
   280
  \item "Exception- Size raised"
walther@59779
   281
    in Build_Thydata.thy
walther@59779
   282
  \item "exception Size raised (line 169 of "./basis/LibrarySupport.sml")"
walther@59779
   283
    in test/../biegelinie-*.xml.
walther@59779
   284
  \end{itemize}
walther@59779
   285
  This has been detected after changeset (30cd47104ad7) "lucin: reorganise theories in ProgLang".
walther@59779
   286
walther@59779
   287
  Find tools to investigate the Exception, and find ways around it eventually.
walther@59779
   288
\<close>
walther@59779
   289
subsection \<open>Cleanup & review signatures wrt. implementation.pdf canonical argument order\<close>
walther@59779
   290
text \<open>
walther@59779
   291
  \begin{itemize}
walther@59779
   292
  \item there are comments in several signatures
walther@59779
   293
  \item ML_file "~~/src/Tools/isac/Interpret/specification-elems.sml" can be (almost) deleted
walther@59779
   294
  \item src/../Frontend/: signatures missing
walther@59779
   295
  \item xxx
walther@59779
   296
  \end{itemize}
walther@59779
   297
\<close>
walther@59779
   298
subsection \<open>overall structure of code\<close>
walther@59779
   299
text \<open>
walther@59779
   300
  \begin{itemize}
walther@59779
   301
  \item try to separate Isac_Knowledge from MathEngine
walther@59779
   302
    common base: Knowledge_Author / ..??
walther@59779
   303
  \item xxx
walther@59779
   304
  \item  ML_file "~~/src/Tools/isac/Interpret/ctree.sml" (*shift to base in common with Interpret*)
walther@59779
   305
  \item xxx
walther@59779
   306
  \item xxx
walther@59779
   307
  \item xxx
walther@59779
   308
  \end{itemize}
walther@59779
   309
\<close>
walther@59779
   310
subsection \<open>Separate MathEngineBasic/ Specify/ Interpret/ MathEngine/\<close>
walther@59779
   311
text \<open>
walther@59779
   312
  \begin{itemize}
walther@59779
   313
  \item xxx
walther@59800
   314
  \item xxx
walther@59734
   315
  \item re-organise code for Interpret
walther@59734
   316
    \begin{itemize}
walther@59933
   317
    \item Step*: Step_Specify | Step_Solve | Step DONE
walther@59734
   318
    \item xxx
walther@59848
   319
    \item Prog_Tac: fun get_first_argument takes both Prog_Tac + Program --- wait for separate Tactical
walther@59800
   320
      then shift into common descendant
walther@59734
   321
    \item xxx
walther@59734
   322
    \end{itemize}
walther@59734
   323
  \item xxx
walther@59778
   324
  \item xxx
walther@59791
   325
  \item ??????????? WHY CAN LI.by_tactic NOT BE REPLACED BY Step_Solve.by_tactic ???????????
walther@59778
   326
  \item xxx
walther@59778
   327
  \item xxx
walther@59778
   328
  \end{itemize}
walther@59778
   329
\<close>
wneuper@59574
   330
subsection \<open>Review modelling- + specification-phase\<close>
wneuper@59574
   331
text \<open>
wneuper@59574
   332
  \begin{itemize}
walther@59816
   333
  \item xxx
walther@59820
   334
  \item xxx
walther@59820
   335
  \item xxx
walther@59816
   336
  \item check match between args of partial_function and model-pattern of meth;
walther@59816
   337
     provide error message.
walther@59778
   338
  \item xxx
wneuper@59574
   339
  \item "--- hack for funpack: generalise handling of meths which extend problem items ---"
wneuper@59569
   340
    \begin{itemize}
wneuper@59574
   341
    \item see several locations of hack in code
wneuper@59574
   342
    \item these locations are NOT sufficient, see
wneuper@59574
   343
      test/../biegelinie-3.sml --- IntegrierenUndKonstanteBestimmen2: Bsp.7.70. auto ---
wneuper@59574
   344
    \item "fun associate" "match_ags ..dI" instead "..pI" breaks many tests, however,
wneuper@59574
   345
      this would be according to survey Notes (3) in src/../calchead.sml.
wneuper@59574
   346
    \end{itemize}
wneuper@59574
   347
  \item see "failed trial to generalise handling of meths"98298342fb6d
wneuper@59574
   348
  \item abstract specify + nxt_specif to common aux-funs;
wneuper@59574
   349
    see e.g. "--- hack for funpack: generalise handling of meths which extend problem items ---"
wneuper@59574
   350
  \item xxx
wneuper@59574
   351
  \item type model = itm list ?
wneuper@59574
   352
  \item review survey Notes in src/../calchead.sml: they are questionable
wneuper@59574
   353
  \item review copy-named, probably two issues commingled 
wneuper@59574
   354
    \begin{itemize}
wneuper@59574
   355
    \item special handling of "#Find#, because it is not a formal argument of partial_function
wneuper@59574
   356
    \item special naming for solutions of equation solving: x_1, x_2, ...
wneuper@59569
   357
    \end{itemize}
wneuper@59569
   358
  \item xxx
walther@59634
   359
  \item xxx
wneuper@59574
   360
  \item this has been written in one go:
wneuper@59574
   361
    \begin{itemize}
walther@59997
   362
    \item reconsidering I_Model.max_vt, use problem with meth ["DiffApp", "max_by_calculus"]
wneuper@59574
   363
    \item reconsider add_field': where is it used for what? Shift into mk_oris
wneuper@59574
   364
    \item reconsider match_itms_oris: where is it used for what? max_vt ONLY???
wneuper@59574
   365
    \item in Specify_Method search root-oris for items (e.g. "errorBound"), #1# in survey
wneuper@59574
   366
    \item Specify_Problem, Specify_Method: check respective identifiers after re-Specify_
wneuper@59574
   367
      (relevant for pre-condition)
wneuper@59574
   368
    \item unify match_ags to mk_oris1..N with different args (fmz | pat list, pbl | meth
wneuper@59574
   369
    \item 
wneuper@59574
   370
    \end{itemize}
wneuper@59574
   371
  \end{itemize}
wneuper@59574
   372
\<close>
wneuper@59574
   373
subsection \<open>taci list, type step\<close>
wneuper@59574
   374
text \<open>
walther@59762
   375
taci was, most likely, invented to make "fun me" more efficient by avoiding duplicate rewrite,
walther@59762
   376
and probably, because the Kernel interface separated setNextTactic and applyTactic.
walther@59816
   377
Both are no good reasons to make code more complicated.
walther@59814
   378
walther@59816
   379
!!! taci list is used in do_next !!!
walther@59814
   380
wneuper@59574
   381
  \begin{itemize}
walther@59762
   382
  \item xxx
walther@59820
   383
  \item can lev_on_total replace lev_on ? ..Test_Isac_Short + rename lev_on_total -> lev_on
walther@59820
   384
  \item xxx
walther@59981
   385
  \item Step* functions should return Calc.T instead of Calc.state_post
walther@59762
   386
  \item xxx
wneuper@59574
   387
  \item states.sml: check, when "length tacis > 1"
wneuper@59574
   388
  \item in Test_Isac.thy there is only 1 error in Interpret/inform.sml
wneuper@59574
   389
  \item (*WN190713 REMOVE: "creating a new node" was never implemented for more than one node?!?
wneuper@59569
   390
  \item xxx
walther@59816
   391
  \item brute force setting all empty ([], [], ptp) works!?! but ptp causes errors -- investigate!
walther@59762
   392
  \item xxx
wneuper@59573
   393
  \end{itemize}
wneuper@59574
   394
\<close>
wneuper@59574
   395
subsection \<open>Ctree\<close>
wneuper@59574
   396
text \<open>
walther@59815
   397
analysis
walther@59815
   398
# mixture pos' .. pos in cappend_*, append_* is confusing
walther@59844
   399
# existpt p pt andalso Tactic.is_empty DIFFERENT IN append_*, cappend_* is confusing
walther@59815
   400
  "exception PTREE "get_obj: pos =" ^^^^^: ^^^^ due to cut !!!
walther@59815
   401
  NOTE: exn IN if..andalso.. IS NOT!!! DETECTED, THIS                       is confusing
walther@59815
   402
  see test/../--- Minisubpbl/800-append-on-Frm.sml ---
walther@59815
   403
# ?!? "cut branches below cannot be decided here" in append_atomic
walther@59815
   404
# sign. of functions too different ?!?canonical arg.order ?!?
wneuper@59568
   405
  \begin{itemize}
walther@59807
   406
  \item xxx
walther@59815
   407
  \item remove update_branch, update_*? -- make branch, etc args of append_*
walther@59815
   408
  \item xxx
walther@59816
   409
  \item close sig Ctree, contains cappend_* ?only? --- ?make parallel to ?Pide_Store?
walther@59813
   410
  \item xxx
walther@59807
   411
  \item unify args to Ctree.state (pt, p)
walther@59846
   412
  \item  fun update_env       .. repl_env                   \<rightarrow>updatempty
walther@59807
   413
  \item xxx
wneuper@59568
   414
  \item xxx
wneuper@59574
   415
  \item xxx
walther@59807
   416
  \item xxx
wneuper@59568
   417
  \end{itemize}
wneuper@59574
   418
\<close>
wneuper@59574
   419
subsection \<open>replace theory/thy by context/ctxt\<close>
wneuper@59574
   420
text \<open>
wneuper@59574
   421
  \begin{itemize}
walther@59660
   422
  \item xxx
walther@59748
   423
  \item Specify/ works with thy | Interpret/ works with ctxt | MathEngine.step works with ?!?ctxt
walther@59748
   424
    special case: Tactic.Refine_Problem
walther@59748
   425
  \item xxx
walther@59748
   426
  \item theory can be retrieved from ctxt by Proof_Context.theory_of
walther@59660
   427
  \item xxx
wneuper@59577
   428
  \item cleaup the many conversions string -- theory
wneuper@59577
   429
  \item make dest_spec --> (theory, pblID, metID) ?+ common_subthy ?
wneuper@59574
   430
  \item 1. Rewrite.eval_true_, then
walther@59933
   431
    LItool.check_leaf, Rewrite.eval_prog_expr, Step.add, LItool.tac_from_prog.
wneuper@59577
   432
  \item fun associate
walther@59881
   433
    let val thy = ThyC.get_theory "Isac_Knowledge";(*TODO*)
wneuper@59574
   434
  \item xxx
wneuper@59574
   435
  \item xxx
walther@59802
   436
  \item in locate_input_tactic .. ?scan_dn1?; Program.is_eval_expr   .use  Term.exists_Const
walther@59802
   437
  \item push srls into pstate
walther@59851
   438
  \item lucas-intrpreter.locate_input_tactic: scan_to_tactic1 srls tac cstate (progr, Rule_Set.Empty)
walther@59851
   439
                                                                                      ^^^^^^^^^^^^^^^
wneuper@59577
   440
  \item xxx
wneuper@59574
   441
  \end{itemize}
wneuper@59574
   442
\<close>
wneuper@59583
   443
subsection \<open>Rfuns, Begin_/End_Detail', Rrls, Istate\<close>
wneuper@59574
   444
text \<open>
walther@59878
   445
remove refactor Rfuns, Rule.Prog, Rule.Empty_Prog, RrlsState: this is a concept never brought to work.
walther@59850
   446
  Clarify relation to reverse rewriting!
wneuper@59562
   447
  \begin{itemize}
walther@59850
   448
  \item separate mut.recursion program with rule and rls by deleting fild scr in rls
walther@59850
   449
    (possible since CS 43160c1e775a
walther@59850
   450
  ` "replace Prog. in prep_rls by Auto_Prog.gen, which generates Prog. on the fly" )
wneuper@59573
   451
  \item xxx
wneuper@59569
   452
  \item probably only "normal_form" seems to be needed
wneuper@59569
   453
  \item deleted Rfuns in NEW "locate_input_tactic": no active test for "locate_rule"
wneuper@59569
   454
    but that seems desirable
wneuper@59569
   455
  \item ?how is the relation to reverse-rewriting ???
wneuper@59569
   456
  \item "Rfuns" markers in test/../rational
wneuper@59562
   457
  \item xxx
walther@59667
   458
  \item datatype istate (Istate.T): remove RrlsState, pstate: use Rrls only for creating results beyond
wneuper@59573
   459
    rewriting and/or respective intermediate steps (e.g. cancellation of fractions).
wneuper@59583
   460
    Thus we get a 1-step-action which does NOT require a state beyond istate/pstate.
wneuper@59573
   461
    Thus we drastically reduce complexity, also get rid of "fun from_pblobj_or_detail_calc" , etc.
wneuper@59573
   462
  \item debug ^^^ related: is there an occurence of Steps with more than 1 element?
wneuper@59569
   463
  \item xxx
walther@59760
   464
  \item and do_next (* WN1907: ?only for Begin_/End_Detail' DEL!!!*)
wneuper@59573
   465
  \item xxx
wneuper@59573
   466
  \item shouldn't go Rfuns from Rewrite --> Rewrite_Set; they behave similar to "fun interSteps" ?
walther@59850
   467
  \item xxx
walther@59850
   468
  \item ?finally Prog could go from Calcelems to ProgLang?
wneuper@59562
   469
  \end{itemize}
wneuper@59574
   470
\<close>
wneuper@59574
   471
subsection \<open>Inverse_Z_Transform.thy\<close>
wneuper@59574
   472
text \<open>
wneuper@59538
   473
  \begin{itemize}
wneuper@59550
   474
  \item\label{new-var-rhs} rule1..6, ruleZY introduce new variables on the rhs of the rewrite-rule.
wneuper@59550
   475
  ? replace rewriting with substitution ?!?
wneuper@59537
   476
  The problem is related to the decision of typing for "d_d" and making bound variables free (while
wneuper@59550
   477
  shifting specific handling in equation solving etc. to the meta-logic). 
wneuper@59550
   478
  \item Find "stepResponse (x[n::real]::bool)" is superfluous, because immediately used by
wneuper@59550
   479
    rewrite-rules; see \ref{new-var-rhs}.
wneuper@59538
   480
  \item Reconsider whole problem:
wneuper@59538
   481
    input only the polynomial as argument of partial_function, in ([1], Frm) compile lhs "X z" ?
wneuper@59538
   482
  \end{itemize}
wneuper@59574
   483
\<close>
wneuper@59574
   484
subsection \<open>Adopt Isabelle's numerals for Isac\<close>
wneuper@59574
   485
text \<open>
wneuper@59540
   486
  \begin{itemize}
wneuper@59574
   487
  \item replace numerals of type "real" by "nat" in some specific functions from ListC.thy
wneuper@59574
   488
    and have both representations in parallel for "nat".
wneuper@59574
   489
  \item xxx
wneuper@59574
   490
  \item xxx
wneuper@59540
   491
  \end{itemize}
wneuper@59574
   492
\<close>
walther@59816
   493
subsection \<open>Redesign equation solver\<close>
wneuper@59591
   494
text \<open>
wneuper@59591
   495
  Existing solver is structured along the WRONG assumption,
walther@59816
   496
  that Poly.thy must be the LAST thy among all thys involved -- while the opposite is the case.
wneuper@59591
   497
wneuper@59591
   498
  Preliminary solution: all inappropriately located thms are collected in Base_Tools.thy
wneuper@59591
   499
\<close>
walther@59816
   500
subsection \<open>Finetunig required for xmldata in kbase\<close>
wneuper@59574
   501
text \<open>
wneuper@59574
   502
  See xmldata https://intra.ist.tugraz.at/hg/isac/rev/5b222a649390
wneuper@59574
   503
  and in kbase html-representation generated from these xmldata.
wneuper@59574
   504
  Notes in ~~/xmldata/TODO.txt.
wneuper@59574
   505
\<close>
wneuper@59574
   506
wneuper@59574
   507
section \<open>Hints for further development\<close>
wneuper@59574
   508
text \<open>
wneuper@59574
   509
\<close>
wneuper@59591
   510
subsection \<open>Coding standards & some explanations for math-authors\<close>
wneuper@59591
   511
text \<open>copy from doc/math-eng.tex WN.28.3.03
wneuper@59591
   512
WN071228 extended\<close>
wneuper@59591
   513
wneuper@59591
   514
subsubsection \<open>Identifiers\<close>
wneuper@59591
   515
text \<open>Naming is particularily crucial, because Isabelles name space is global, and isac does
wneuper@59591
   516
  not yet use the novel locale features introduces by Isar. For instance, {\tt probe} sounds
wneuper@59591
   517
  reasonable as (1) a description in the model of a problem-pattern, (2) as an element of the
wneuper@59591
   518
  problem hierarchies key, (3) as a socalled CAS-command, (4) as the name of a related script etc.
wneuper@59591
   519
  However, all the cases (1)..(4) require different typing for one and the same
wneuper@59591
   520
  identifier {\tt probe} which is impossible, and actually leads to strange errors
wneuper@59591
   521
  (for instance (1) is used as string, except in a script addressing a Subproblem).
wneuper@59591
   522
wneuper@59591
   523
  These are the preliminary rules for naming identifiers>
wneuper@59591
   524
  \begin{description}
wneuper@59591
   525
  \item [elements of a key] into the hierarchy of problems or methods must not contain
wneuper@59591
   526
    capital letters and may contain underscrores, e.g. {\tt probe, for_polynomials}.
wneuper@59591
   527
  \item [descriptions in problem-patterns] must contain at least 1 capital letter and
wneuper@59591
   528
    must not contain underscores, e.g. {\tt Probe, forPolynomials}.
wneuper@59591
   529
  \item [CAS-commands] follow the same rules as descriptions in problem-patterns above, thus
wneuper@59591
   530
    beware of conflicts~!
wneuper@59591
   531
  \item [script identifiers] always end with {\tt Program}, e.g. {\tt ProbeScript}.
wneuper@59591
   532
  \item [???] ???
wneuper@59591
   533
  \item [???] ???
wneuper@59591
   534
  \end{description}
wneuper@59591
   535
%WN071228 extended\<close>
wneuper@59591
   536
wneuper@59591
   537
subsubsection \<open>Rule sets\<close>
wneuper@59591
   538
text \<open>The actual version of the coding standards for rulesets is in {\tt /IsacKnowledge/Atools.ML
wneuper@59591
   539
  where it can be viewed using the knowledge browsers.
wneuper@59591
   540
wneuper@59591
   541
  There are rulesets visible to the student, and there are rulesets visible (in general) only for
wneuper@59591
   542
  math authors. There are also rulesets which {\em must} exist for {\em each} theory;
wneuper@59591
   543
  these contain the identifier of the respective theory (including all capital letters) 
wneuper@59591
   544
  as indicated by {\it Thy} below.
wneuper@59591
   545
wneuper@59591
   546
  \begin{description}
wneuper@59591
   547
  \item [norm\_{\it Thy}] exists for each theory, and {\em efficiently} calculates a
wneuper@59591
   548
    normalform for all terms which can be expressed by the definitions of the respective theory
wneuper@59591
   549
    (and the respective parents).
wneuper@59591
   550
  \item [simplify\_{\it Thy}] exists for each theory, and calculates a normalform for all terms
wneuper@59591
   551
    which can be expressed by the definitions of the respective theory (and the respective parents)
wneuper@59591
   552
    such, that the rewrites can be presented to the student.
wneuper@59591
   553
  \item [calculate\_{\it Thy}] exists for each theory, and evaluates terms with 
wneuper@59591
   554
    numerical constants only (i.e. all terms which can be expressed by the definitions of
wneuper@59591
   555
    the respective theory and the respective parent theories). In particular, this ruleset includes
wneuper@59591
   556
    evaluating in/equalities with numerical constants only.
wneuper@59591
   557
    WN.3.7.03: may be dropped due to more generality: numericals and non-numericals
wneuper@59591
   558
    are logically equivalent, where the latter often add to the assumptions
wneuper@59591
   559
    (e.g. in Check_elementwise).
wneuper@59591
   560
  \end{description}
wneuper@59591
   561
wneuper@59591
   562
  The above rulesets are all visible to the user, and also may be input; 
wneuper@59591
   563
  thus they must be contained in {\tt Theory_Data} (KEStore_Elems.add_rlss,
wneuper@59591
   564
  KEStore_Elems.get_rlss). All these rulesets must undergo a preparation
wneuper@59591
   565
  using the function {\tt prep_rls'}, which generates a script for stepwise rewriting etc.
wneuper@59591
   566
  The following rulesets are used for internal purposes and usually invisible to the (naive) user:
wneuper@59591
   567
wneuper@59591
   568
  \begin{description}
wneuper@59591
   569
  \item [*\_erls] TODO
wneuper@59591
   570
  \item [*\_prls] 
wneuper@59591
   571
  \item [*\_srls] 
wneuper@59591
   572
  \end{description}
walther@59852
   573
{\tt Rule_Set.append_rules, Rule_Set.merge, remove_rls} TODO
wneuper@59591
   574
\<close>
wneuper@59591
   575
wneuper@59574
   576
subsection \<open>get proof-state\<close>
wneuper@59574
   577
text \<open>
wneuper@59574
   578
  Re: [isabelle] Programatically get "this"
wneuper@59574
   579
  ----------------------------------------------------
wneuper@59574
   580
  So here is my (Makarius') version of your initial example, following these principles:
wneuper@59574
   581
  begin{verbatim}
wneuper@59574
   582
    notepad
wneuper@59574
   583
    begin
wneuper@59574
   584
      assume a: A
wneuper@59574
   585
      ML_val \<open>
wneuper@59574
   586
        val ctxt = @{context};
wneuper@59558
   587
    
wneuper@59574
   588
        val this_name =
walther@59748
   589
          Name_Space.full_name (Proof_Context.naming_of ctxt) (Binding.name Auto_Bind.thisN);
wneuper@59574
   590
        val this = #thms (the (Proof_Context.lookup_fact ctxt this_name));
wneuper@59574
   591
      \<close>
wneuper@59574
   592
    end
wneuper@59574
   593
  end{verbatim}
wneuper@59574
   594
\<close>
wneuper@59574
   595
subsection \<open>write Specification to jEdit\<close>
wneuper@59574
   596
text \<open>
wneuper@59574
   597
  Re: [isabelle] Printing terms with type annotations
wneuper@59574
   598
  ----------------------------------------------------
wneuper@59574
   599
  On 06/02/2019 17:52, Moa Johansson wrote:
wneuper@59574
   600
  >
wneuper@59574
   601
  > I’m writing some code that should create a snippet of Isar script.
wneuper@59574
   602
  
wneuper@59574
   603
  This is how Sledgehammer approximates this:
wneuper@59574
   604
  
wneuper@59574
   605
  http://isabelle.in.tum.de/repos/isabelle/file/Isabelle2018/src/HOL/Tools/Sledgehammer/sledgehammer_isar_proof.ML#l299
wneuper@59574
   606
  
wneuper@59574
   607
  (The module name already shows that the proper terminology is "Isar
wneuper@59574
   608
  proof" (or "Isar proof text").  Proof scripts are a thing from the past,
wneuper@59574
   609
  before Isar. You can emulate old-style proof scripts via a sequence of
wneuper@59574
   610
  'apply' commands, but this is improper Isar.)
wneuper@59574
   611
  
wneuper@59574
   612
  Note that there is no standard function in Isabelle/Pure, because the
wneuper@59574
   613
  problem to print just the right amount of type information is very
wneuper@59574
   614
  complex and not fully solved. One day, after 1 or 2 rounds of
wneuper@59574
   615
  refinements over the above approach, it might become generally available.
wneuper@59574
   616
\<close>
wneuper@59574
   617
subsection \<open>follow Isabelle conventions (*Does not yet work in Isabelle2018\<close>
wneuper@59574
   618
text \<open>
wneuper@59574
   619
  isabelle update -u path_cartouches
wneuper@59574
   620
  isabelle update -u inner_syntax_cartouches
wneuper@59574
   621
\<close>
wneuper@59582
   622
section \<open>Questions to Isabelle experts\<close>
wneuper@59582
   623
text \<open>
wneuper@59582
   624
\begin{itemize}
walther@59848
   625
\item ad ERROR Undefined fact "all_left"        in Test_Isac: error-pattern.sml
walther@59848
   626
               Undefined fact: "xfoldr_Nil"                   inssort.sml
walther@59886
   627
    (* probably two different reasons:
walther@59886
   628
    src/../LinEq.thy
walther@59886
   629
      (*WN0509 compare PolyEq.all_left "[|Not(b=!=0)|] ==> (a = b) = (a - b = 0)"*)
walther@59886
   630
      all_left:          "[|Not(b=!=0)|] ==> (a=b) = (a+(-1)*b=0)" and
walther@59886
   631
    
walther@59886
   632
    src/../PolyEq.thy
walther@59886
   633
      (*WN0509 compare LinEq.all_left "[|Not(b=!=0)|] ==> (a=b) = (a+(-1)*b=0)"*)
walther@59886
   634
      all_left:              "[|Not(b=!=0)|] ==> (a = b) = (a - b = 0)" and
walther@59886
   635
    
walther@59886
   636
    test/../partial_fractions.sml
walther@59886
   637
    (*[7], Met*)val (p,_,f,nxt,_,pt) = me nxt p [] pt; (*nxt = Apply_Method ["PolyEq", "normalise_poly"])*)
walther@59886
   638
    (*[7, 1], Frm*)val (p,_,f,nxt,_,pt) = me nxt p [] pt; (*nxt = Rewrite ("all_left", "\<not> ?b =!= 0 \<Longrightarrow> (?a = ?b) = (?a - ?b = 0)"))*)
walther@59886
   639
    
walther@59886
   640
    test/../mathengine-stateless.sml
walther@59886
   641
    (*if ThmC.string_of_thm @ {thm rnorm_equation_add} =  "\<not> ?b =!= 0 \<Longrightarrow> (?a = ?b) = (?a + - 1 * ?b = 0)"
walther@59886
   642
    then () else error "string_of_thm changed";*)
walther@59886
   643
    
walther@59886
   644
    (*---------------------------------------------------------------------------------------------*)
walther@59886
   645
    src/../LinEq.thy
walther@59886
   646
    primrec xfoldr :: "('a \<Rightarrow> 'b \<Rightarrow> 'b) \<Rightarrow> 'a xlist \<Rightarrow> 'b \<Rightarrow> 'b" where
walther@59886
   647
    xfoldr_Nil:  "xfoldr f {|| ||} = id" |
walther@59886
   648
    xfoldr_Cons: "xfoldr f (x @# xs) = f x \<circ> xfoldr f xs"
walther@59886
   649
    
walther@59886
   650
    src/../InsSort.thy
walther@59886
   651
        srls = Rule_Set.empty, calc = [], rules = [
walther@59886
   652
          Rule.Thm ("xfoldr_Nil",(*num_str*) @{thm xfoldr_Nil} (* foldr ?f [] = id *)),
walther@59886
   653
    *)
walther@59841
   654
\item xxx
walther@59841
   655
\item xxx
walther@59842
   656
\item ?OK Test_Isac_Short with
walther@59842
   657
    LI.by_tactic tac (get_istate_LI pt p, get_ctxt_LI pt p) ptp
walther@59842
   658
  instead
walther@59846
   659
    LI.by_tactic tac (Istate.empty, ContextC.empty) ptp
walther@59842
   660
  in step-solve ?
walther@59842
   661
\item xxx
walther@59842
   662
\item test from last CS with outcommented re-def of code -> 
walther@59842
   663
  -> \<open>further tests additional to src/.. files\<close>
walther@59842
   664
      ADDTESTS/redefined-code.sml
walther@59841
   665
\item xxx
walther@59841
   666
\item efb749b79361 Test_Some_Short.thy has 2 errors, which disappear in thy ?!?:
walther@59841
   667
  ML_file "Interpret/error-pattern.sml" Undefined fact: "all_left"
walther@59841
   668
  ML_file "Knowledge/inssort.sml" Undefined fact: "xfoldr_Nil"
walther@59841
   669
\item xxx
wneuper@59591
   670
\item what is the actual replacement of "hg log --follow" ?
wneuper@59591
   671
\item xxx
wneuper@59582
   672
\item how HANDLE these exceptions, e.g.:
wneuper@59582
   673
    Syntax.read_term ctxt "Randbedingungen y 0 = (0::real), y L = 0, M_b 0 = 0, M_b L = 0]"
wneuper@59582
   674
  GIVES
wneuper@59582
   675
    "Inner syntax error
wneuper@59582
   676
     Failed to parse term"
wneuper@59582
   677
\item xxx
walther@59734
   678
\item how cope with "exception Size raised (line 171 of "./basis/LibrarySupport.sml")"
walther@59734
   679
  e.g. in test/Interpret/lucas-interpreter.sml
wneuper@59582
   680
\item xxx
wneuper@59582
   681
\item xxx
wneuper@59582
   682
\end{itemize}
wneuper@59582
   683
\<close>
wneuper@59582
   684
wneuper@59574
   685
section \<open>For copy & paste\<close>
wneuper@59574
   686
text \<open>
wneuper@59582
   687
\begin{itemize}
walther@59778
   688
\item xxx
wneuper@59558
   689
  \begin{itemize}
wneuper@59558
   690
  \item xxx
wneuper@59540
   691
    \begin{itemize}
wneuper@59558
   692
    \item xxx
wneuper@59540
   693
      \begin{itemize}
wneuper@59558
   694
      \item xxx
wneuper@59574
   695
        \begin{itemize}
wneuper@59574
   696
        \item xxx
wneuper@59574
   697
        \end{itemize}
wneuper@59540
   698
      \end{itemize}
wneuper@59540
   699
    \end{itemize}
wneuper@59504
   700
  \end{itemize}
wneuper@59504
   701
\end{itemize}
wneuper@59504
   702
\<close>
wneuper@59574
   703
subsection \<open>xxx\<close>
wneuper@59574
   704
subsubsection \<open>xxx\<close>
neuper@52150
   705
end