Skip to main content

guidelines - Package organization


When writing a Mathematica package Foo, with functions f1, f2 and f3, one can use the template:


BeginPackage["Foo`"];

f1::usage = "f1[] ....";


f2::usage = "f2[] ....";

Begin["`Private`"];

f1[]:= code for f1

f2[]:= code for f2

f3[]:= code for f3 (not visible as only in the private context)


End[];

EndPackage[];

What I do not like is when your package is growing, there can be a long "distance" (not fitting in your text editor) between "f1::usage" and the actual f1 code. This is error prone concerning coherence between doc and code. So I would like to group common stuff together.


My question is:


Is it possible and is it a good practice (without side effect) to group things like below?


BeginPackage["Foo`"];


Begin["`Private`"];

Foo`f1::usage = "f1[] ....";

Foo`f1[]:= code for f1

...

Foo`f2::usage = "f2[] ....";


Foo`f2[]:= code for f2

...

f3[]:= code for f3 (private as before)

End[]

EndPackage[];

Answer




The key point is not to set the usage message between BeginPackage and Begin["`Private`"], but just to mention the symbol.


A better way to do this would be:


BeginPackage["Foo`"];

f1
f2

Begin["`Private`"];

f1::usage = "f1[] ....";

f1[]:= code for f1

f2::usage = "f2[] ....";
f2[]:= code for f2

f3[]:= code for f3 (not visible as only in the private context)

End[];

EndPackage[];


Whatever you mention there will be a public symbol (f1, f2). What you don't mention will not be public (f3). That's because after the BeginPackage, $Context will be Foo`, meaning that new symbols are created there. $Context controls where new symbols are created. After the Begin["`Private`"], $Context is changed, but Foo` is still in $ContextPath. $ContextPath controls where Mathematica should look for symbol names. It only creates a new symbol if it didn't find the name in $ContextPath.


You could use the explicit context for every definition, but personally I don't like this because it keeps repeating the name of the context, thus making it difficult to change in the future. It is also good to point out that you'd only need to use an explicit context when mentioning the symbol for the first time. I.e. this would be sufficient (though potentially confusing):


Foo`f1::usage = "f1[] ....";

f1[]:= code for f1

It is good practice to use different naming conventions for public and non-public symbols. Public ones are preferably capitalized. This will also help in catching errors such as not making a symbol public.


Comments

Post a Comment

Popular posts from this blog

functions - Get leading series expansion term?

Given a function f[x] , I would like to have a function leadingSeries that returns just the leading term in the series around x=0 . For example: leadingSeries[(1/x + 2)/(4 + 1/x^2 + x)] x and leadingSeries[(1/x + 2 + (1 - 1/x^3)/4)/(4 + x)] -(1/(16 x^3)) Is there such a function in Mathematica? Or maybe one can implement it efficiently? EDIT I finally went with the following implementation, based on Carl Woll 's answer: lds[ex_,x_]:=( (ex/.x->(x+O[x]^2))/.SeriesData[U_,Z_,L_List,Mi_,Ma_,De_]:>SeriesData[U,Z,{L[[1]]},Mi,Mi+1,De]//Quiet//Normal) The advantage is, that this one also properly works with functions whose leading term is a constant: lds[Exp[x],x] 1 Answer Update 1 Updated to eliminate SeriesData and to not return additional terms Perhaps you could use: leadingSeries[expr_, x_] := Normal[expr /. x->(x+O[x]^2) /. a_List :> Take[a, 1]] Then for your examples: leadingSeries[(1/x + 2)/(4 + 1/x^2 + x), x] leadingSeries[Exp[x], x] leadingSeries[(1/x + 2 + (1 - 1/x...
Post a Comment
Read more

How to thread a list

I have data in format data = {{a1, a2}, {b1, b2}, {c1, c2}, {d1, d2}} Tableform: I want to thread it to : tdata = {{{a1, b1}, {a2, b2}}, {{a1, c1}, {a2, c2}}, {{a1, d1}, {a2, d2}}} Tableform: And I would like to do better then pseudofunction[n_] := Transpose[{data2[[1]], data2[[n]]}]; SetAttributes[pseudofunction, Listable]; Range[2, 4] // pseudofunction Here is my benchmark data, where data3 is normal sample of real data. data3 = Drop[ExcelWorkBook[[Column1 ;; Column4]], None, 1]; data2 = {a #, b #, c #, d #} & /@ Range[1, 10^5]; data = RandomReal[{0, 1}, {10^6, 4}]; Here is my benchmark code kptnw[list_] := Transpose[{Table[First@#, {Length@# - 1}], Rest@#}, {3, 1, 2}] &@list kptnw2[list_] := Transpose[{ConstantArray[First@#, Length@# - 1], Rest@#}, {3, 1, 2}] &@list OleksandrR[list_] := Flatten[Outer[List, List@First[list], Rest[list], 1], {{2}, {1, 4}}] paradox2[list_] := Partition[Riffle[list[[1]], #], 2] & /@ Drop[list, 1] RM[list_] := FoldList[Transpose[{First@li...
Post a Comment
Read more

front end - keyboard shortcut to invoke Insert new matrix

I frequently need to type in some matrices, and the menu command Insert > Table/Matrix > New... allows matrices with lines drawn between columns and rows, which is very helpful. I would like to make a keyboard shortcut for it, but cannot find the relevant frontend token command (4209405) for it. Since the FullForm[] and InputForm[] of matrices with lines drawn between rows and columns is the same as those without lines, it's hard to do this via 3rd party system-wide text expanders (e.g. autohotkey or atext on mac). How does one assign a keyboard shortcut for the menu item Insert > Table/Matrix > New... , preferably using only mathematica? Thanks! Answer In the MenuSetup.tr (for linux located in the $InstallationDirectory/SystemFiles/FrontEnd/TextResources/X/ directory), I changed the line MenuItem["&New...", "CreateGridBoxDialog"] to read MenuItem["&New...", "CreateGridBoxDialog", MenuKey["m", Modifiers-...
Post a Comment
Read more