Skip to main content

front end - Syntax highlighter shows error for Manipulate when it's inside a Block or a Module


I'm putting my new copy of Mathematica 10 through its paces and I noticed a weird change in the colouring scheme that I find very annoying, and I'd like to get some insight into why it's happening.


The change happens, as far as I can tell, for variables that have been set in some scoping construct which are then used inside of a Manipulate command. Thus, for example, the code


Module[
{A = 1},
Manipulate[
Plot[
A Sin[k x]
, {x, 0, 20}

]
, {k, 1, 10}
]
]

renders differently in the Mathematica 9 and 10 frontends:


enter image description here


Playing around in Edit > Preferences > Appearance > Syntax Coloring > Errors and Warnings, the error class that this is attributed to is



Variables that will go out of scope before being used




though what that means exactly isn't very clear to me. Therefore, I have some questions:




  • Is this in fact an incorrect usage? If so, why, and what alternative construct should I use? (I notice, in particular, that in version 10 the red colour is displayed for Block and Module but not for With.)




  • Why did this only start happening in version 10? Which version is right?





  • If this sort of code is OK, can I safely disable this sort of error marking? What risks does that entail?





Answer



Based on Mr.Wizard's answer and comments by Szabolcs and celtschk, I now understand that the code I posted does have undesirable side-effects and it should be avoided. Specifically, the scoping constructs Module and Block are meant to completely localize the variables in their first argument (for more information see this question). However, placing their scoped variables inside a Manipulate (or other dynamic construct) can cause the values to leak, and this should be avoided - hence the syntax error marks.



TL;DR:


Behaviour of the form


Block[{v}, Dynamic[v = 1]]
v


(*
1
1
*)

is unwanted. Scoping constructs which contain Dynamic objects like Manipulate should be replaced by With or DynamicModule.



Modules localize their variables by creating new local variables that are unique for the session. Thus, inside Module[{A}, ... ], the variable A gets replaced by a variable of the form A$1234, and this should not be accessible outside of the Module:


Module[{A},

Print[A]; A = 1
]
(*
A$464
1
*)

A$464
(*
A$464

*)

Placing a Manipulate inside the Module, though, can cause this value to leak:


Module[{A},
Print[A];
Manipulate[A = k, {k, 1, 2}]
]

will produce e.g. A$524 and the Manipulate, and then asking for that variable gives


A$524

(*
1
*)

Block is similar but slightly worse, as it is now the value of the scoped variable itself that can leak. The expected behaviour is


Block[
{A},
Print[A];
A = 1
]

A
(*
A
1
A
*)

but with a Manipulate inside, the value of A outside the Block can change:


Block[{A},
Print[A];

Manipulate[A = k, {k, 1, 2}]
]

returns A and the Manipulate, and then asking for A returns


A
(*
1
*)

This is indeed incorrect and should be avoided.



The correct way to go about it, then, appears to be using a DynamicModule whenever there are dynamic objects inside the scoping construct. This type of Module is indeed capable of containing the side effects described above. Thus,


DynamicModule[{A},
Print[A];
Manipulate[A = k, {k, 1, 2}]
]

will produce e.g. A$827 and the Manipulate, and now the scoped variable A$827 is properly contained:


A$827
(*
A$827

*)

For further details about this, and about the differences between Module and DynamicModule, see Advanced Dynamic Functionality - Module versus DynamicModule. For more on the behaviour of Module, Block and With in different circumstances, see this question.


Comments

Popular posts from this blog

plotting - How to draw lines between specified dots on ListPlot?

I would like to create a plot where I have unconnected dots and some connected. So far, I have figured out how to draw the dots. My code is the following: ListPlot[{{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4,13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full] I have thought using ListLinePlot command, but I don't know how to specify to the command to draw only selected lines between the dots. Do have any suggestions/hints on how to do that? Thank you. Answer One possibility would be to use Epilog with Line : ListPlot[ {{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4, 13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full, Epilog -> { Line[ ...

dynamic - How can I make a clickable ArrayPlot that returns input?

I would like to create a dynamic ArrayPlot so that the rectangles, when clicked, provide the input. Can I use ArrayPlot for this? Or is there something else I should have to use? Answer ArrayPlot is much more than just a simple array like Grid : it represents a ranged 2D dataset, and its visualization can be finetuned by options like DataReversed and DataRange . These features make it quite complicated to reproduce the same layout and order with Grid . Here I offer AnnotatedArrayPlot which comes in handy when your dataset is more than just a flat 2D array. The dynamic interface allows highlighting individual cells and possibly interacting with them. AnnotatedArrayPlot works the same way as ArrayPlot and accepts the same options plus Enabled , HighlightCoordinates , HighlightStyle and HighlightElementFunction . data = {{Missing["HasSomeMoreData"], GrayLevel[ 1], {RGBColor[0, 1, 1], RGBColor[0, 0, 1], GrayLevel[1]}, RGBColor[0, 1, 0]}, {GrayLevel[0], GrayLevel...

Is there a way to do conditional matrix loop using 'continue'

I have the following: n = 3; m = 5; ww = RandomReal[{0, 0.1}, {n, n}]; uu = RandomReal[{0, 1}, {m, n}]; pp = RandomReal[{0, 1}, {n, n}]; ss = RandomInteger[{0, 5}, {m, n}]; Grid[{{"ww", "uu", "pp", "ss"}, {ww // TableForm, uu // TableForm, pp // TableForm, ss // TableForm}}, Spacings -> {5, 2}, Dividers -> All] where I would like to look at every element of matrix ss and produce a matrix tt , with zeroes at the locations in ss which have zeroes, and in all other positions do the following: tt = (-1/Subscript[ww, m]) Log[(1 - uu)/(Subscript[pp, m - 1])], where Subscript[ww, m] is the value at index of ww matrix and where Subscript[pp, m - 1] is the value at index-1 of pp matrix. So for example if the first value ever read from matrix ss happens to be 2, then value taken from matrix ww would be from the row 2, but from pp would be from row 1. Also how to tell difference between a 0 as a valid value from within the matrix elemen...