EdIVdZddlmZmZmZmZmZmZmZm Z m Z ddl m Z ddl mZddlmZddlmZddlmZmZddlmZdd lmZdd lmZmZdd lmZed Zed Z edZ!edZ"edZ#edZ$GddeZ%GddeZ&dZ'GddeZ(GddeZ)GddeZ*GddeZ+Gdd eZ,Gd!d"eZ-Gd#d$eZ.Gd%d&e Z/e/Z0d'Z1e1d(Z2dQd*d)d)d+d,Z3d-Z4d.Z5dRd/Z6dRd0Z7dQd1Z8dRd2Z9dRd3Z:dQd4Z;Gd5d6eZ<Gd7d8eZ=Gd9d:eZ>Gd;dZ?Gd=d>e>Z@Gd?d@e>ZAGdAdBe>ZBGdCdDe>ZCGdEdFe?ZDGdGdHeZEGdIdJeEZFGdKdLeEZGGdMdNeeZHGdOdPeeZId)S)Sz AST nodes specific to Fortran. The functions defined in this module allows the user to express functions such as ``dsign`` as a SymPy function for symbolic manipulation. ) Attribute CodeBlock FunctionCallNodenoneStringToken _mk_TupleVariable)BasicTuple)Expr)Function)FloatInteger)Str)sympifytruefalse)iterablepure elemental intent_in intent_out intent_inout allocatablec6eZdZdZdxZZeZedZ dS)Programaf Represents a 'program' block in Fortran. Examples ======== >>> from sympy.codegen.ast import Print >>> from sympy.codegen.fnodes import Program >>> prog = Program('myprogram', [Print([42])]) >>> from sympy import fcode >>> print(fcode(prog, source_format='free')) program myprogram print *, 42 end program )namebodyct|SNrr"s 4lib/python3.11/site-packages/sympy/codegen/fnodes.pyzProgram.3 40@N) __name__ __module__ __qualname____doc__ __slots___fieldsr_construct_name staticmethod_construct_bodyr*r'r r !s<+*IO"l#@#@AAOOOr*r c"eZdZdZdxZZeZeZdS) use_renamea Represents a renaming in a use statement in Fortran. Examples ======== >>> from sympy.codegen.fnodes import use_rename, use >>> from sympy import fcode >>> ren = use_rename("thingy", "convolution2d") >>> print(fcode(ren, source_format='free')) thingy => convolution2d >>> full = use('signallib', only=['snr', ren]) >>> print(fcode(full, source_format='free')) use signallib, only: snr, thingy => convolution2d )localoriginalN) r+r,r-r.r/r0r_construct_local_construct_originalr4r*r'r6r66s20/I r*r6cNt|dr|jSt|S)Nr!)hasattrr!rargs r'_namer?Js'sFxc{{r*cjeZdZdZdxZZeedZee Z edZ edZ dS)usea Represents a use statement in Fortran. Examples ======== >>> from sympy.codegen.fnodes import use >>> from sympy import fcode >>> fcode(use('signallib'), source_format='free') 'use signallib' >>> fcode(use('signallib', [('metric', 'snr')]), source_format='free') 'use signallib, metric => snr' >>> fcode(use('signallib', only=['snr', 'convolution2d']), source_format='free') 'use signallib, only: snr, convolution2d' ) namespacerenameonly)rCrDc(td|DS)NcNg|]"}t|tr|nt|#Sr4) isinstancer6.0r>s r' z use...csF:D:D:DwzCQ[A\A\:r##blnqbr:D:D:Dr*r argss r'r(z use.cs1%:D:DC:D:D:D3Er*c(td|DS)NcZg|](}t|tr|nt|)Sr4)rGr6r?rHs r'rJz use...ds67{7{7{orz#z?Z?Z8j`efi`j`j7{7{7{r*r rKs r'r(z use.ds7{7{vz7{7{7{0|r*N) r+r,r-r.r/r0rdefaultsr2r?_construct_namespace_construct_rename_construct_onlyr4r*r'rArAPst:9I--H'<..$ &E&EFF"l#|#|}}OOOr*rAcdeZdZdZdxZZdeiZeZ e dZ e dZ dS)Modulea\ Represents a module in Fortran. Examples ======== >>> from sympy.codegen.fnodes import Module >>> from sympy import fcode >>> print(fcode(Module('signallib', ['implicit none'], []), source_format='free')) module signallib implicit none contains end module )r! declarations definitionsrUc,d|D}t|S)NcZg|](}t|trt|n|)Sr4)rGstrrrHs r'rJz2Module._construct_declarations..s1JJJcJsC009CcJJJr*r%)clsrLs r'_construct_declarationszModule._construct_declarations}s JJTJJJ$r*ct|Sr$r%r=s r'r(zModule.s ior*N)r+r,r-r.r/r0rrOrr1 classmethodr[r2_construct_definitionsr4r*r'rTrTgsk"BAI(HO  [ *\*E*EFFr*rTc\eZdZdZdZeejzZeZe dZ e dZ dS) Subroutinea Represents a subroutine in Fortran. Examples ======== >>> from sympy import fcode, symbols >>> from sympy.codegen.ast import Print >>> from sympy.codegen.fnodes import Subroutine >>> x, y = symbols('x y', real=True) >>> sub = Subroutine('mysub', [x, y], [Print([x**2 + y**2, x*y])]) >>> print(fcode(sub, source_format='free', standard=2003)) subroutine mysub(x, y) real*8 :: x real*8 :: y print *, x**2 + y**2, x*y end subroutine )r! parametersr"cDtttj|Sr$)rmapr deduced)paramss r'r(zSubroutine.ss8CSU[?\?\8]r*cBt|tr|St|Sr$)rGr)rZitrs r'r3zSubroutine._construct_bodys# c9 % % #Jc? "r*N) r+r,r-r.r/rr0rr1r2_construct_parametersr]r3r4r*r'r`r`sc$/I$,&GO(L)])]^^##[###r*r`cFeZdZdZdxZZeeZee Z dS)SubroutineCallz Represents a call to a subroutine in Fortran. Examples ======== >>> from sympy.codegen.fnodes import SubroutineCall >>> from sympy import fcode >>> fcode(SubroutineCall('mysub', 'x y'.split())) ' call mysub(x, y)' )r!subroutine_argsN) r+r,r-r.r/r0r2r?r1r _construct_subroutine_argsr4r*r'rjrjsE  65I"l5))O!-i!8!8r*rjceZdZdZdxZZededZe dZ e e Z e e Z e e Ze e Ze dZdS)Doa Represents a Do loop in in Fortran. Examples ======== >>> from sympy import fcode, symbols >>> from sympy.codegen.ast import aug_assign, Print >>> from sympy.codegen.fnodes import Do >>> i, n = symbols('i n', integer=True) >>> r = symbols('r', real=True) >>> body = [aug_assign(r, '+', 1/i), Print([i, r])] >>> do1 = Do(body, i, 1, n) >>> print(fcode(do1, source_format='free')) do i = 1, n r = r + 1d0/i print *, i, r end do >>> do2 = Do(body, i, 1, n, 2) >>> print(fcode(do2, source_format='free')) do i = 1, n, 2 r = r + 1d0/i print *, i, r end do )r"counterfirstlaststep concurrent)rrrsct|Sr$r%r&s r'r(z Do.r)r*c"|rtntSr$rr=s r'r(z Do.sS5KTTer*N)r+r,r-r.r/r0rrrOr2r3r_construct_counter_construct_first_construct_last_construct_step_construct_concurrentr4r*r'rnrns4UTI %88H"l#@#@AAO%g..#|G,,"l7++O"l7++O(L)K)KLLr*rnc0eZdZdZdxZZeeZdS)ArrayConstructoraT Represents an array constructor. Examples ======== >>> from sympy import fcode >>> from sympy.codegen.fnodes import ArrayConstructor >>> ac = ArrayConstructor([1, 2, 3]) >>> fcode(ac, standard=95, source_format='free') '(/1, 2, 3/)' >>> fcode(ac, standard=2003, source_format='free') '[1, 2, 3]' )elementsN) r+r,r-r.r/r0r2r _construct_elementsr4r*r'r}r}s6  ('I&,y11r*r}ceZdZdZdxZZdediZee Z ee Z ee Z ee Z ee ZdS) ImpliedDoLoopa Represents an implied do loop in Fortran. Examples ======== >>> from sympy import Symbol, fcode >>> from sympy.codegen.fnodes import ImpliedDoLoop, ArrayConstructor >>> i = Symbol('i', integer=True) >>> idl = ImpliedDoLoop(i**3, i, -3, 3, 2) # -27, -1, 1, 27 >>> ac = ArrayConstructor([-28, idl, 28]) # -28, -27, -1, 1, 27, 28 >>> fcode(ac, standard=2003, source_format='free') '[-28, (i**3, i = -3, 3, 2), 28]' )exprrorprqrrrrrtN)r+r,r-r.r/r0rrOr2r_construct_exprrwrxryrzr4r*r'rrs  GFI #H"l7++O%g..#|G,,"l7++O"l7++OOOr*rceZdZdZdZdZdS)ExtentaC Represents a dimension extent. Examples ======== >>> from sympy.codegen.fnodes import Extent >>> e = Extent(-3, 3) # -3, -2, -1, 0, 1, 2, 3 >>> from sympy import fcode >>> fcode(e, source_format='free') '-3:3' >>> from sympy.codegen.ast import Variable, real >>> from sympy.codegen.fnodes import dimension, intent_out >>> dim = dimension(e, e) >>> arr = Variable('x', real, attrs=[dim, intent_out]) >>> fcode(arr.as_Declaration(), source_format='free', standard=2003) 'real*8, dimension(-3:3, -3:3), intent(out) :: x' c8t|dkr5|\}}tj|t|t|St|dkst|dkr|ddvrtj|St d)Nrrt):Nz5Expected 0 or 2 args (or one argument == None or ':'))lenr __new__r ValueError)rZrLlowhighs r'rzExtent.__new__s t99> VIC=gcllGDMMBB B YY!^ VD Q V47k3I V=%% %TUU Ur*c~t|jdkrdSdd|jDS)Nrrc34K|]}t|VdSr$)rYrHs r' z#Extent._sympystr..$s(66SC666666r*)rrLjoin)selfprinters r' _sympystrzExtent._sympystr!s? ty>>Q  3xx66DI666666r*N)r+r,r-r.rrr4r*r'rrs?$VVV77777r*rcjt|dkrtdg}|D]}t|tr||-t|t rK|dkr"|tj|t |t|r|t||t|t|dkrtdtd|S)a Creates a 'dimension' Attribute with (up to 7) extents. Examples ======== >>> from sympy import fcode >>> from sympy.codegen.fnodes import dimension, intent_in >>> dim = dimension('2', ':') # 2 rows, runtime determined number of columns >>> from sympy.codegen.ast import Variable, integer >>> arr = Variable('a', integer, attrs=[dim, intent_in]) >>> fcode(arr.as_Declaration(), source_format='free', standard=2003) 'integer*4, dimension(2, :), intent(in) :: a' z0Fortran only supports up to 7 dimensional arraysrrzNeed at least one dimension dimension) rrrGrappendrYrrrr)rLrar>s r'rr)s0 4yy1}MKLLLJ , , c6 " " ,   c " " " " S ! ! ,cz /!!&((++++!!&++.... c]] ,   fcl + + + +   gcll + + + + 4yyA~86777 [* - --r**Nr4)attrsvaluetypect|tr8t|jdkrt dt|zn t |}t ||gz}|F|tttfvrtttd|}| ||tj |||St||||S)a Convenience function for creating a Variable instance for a Fortran array. Parameters ========== symbol : symbol dim : Attribute or iterable If dim is an ``Attribute`` it need to have the name 'dimension'. If it is not an ``Attribute``, then it is passsed to :func:`dimension` as ``*dim`` intent : str One of: 'in', 'out', 'inout' or None \*\*kwargs: Keyword arguments for ``Variable`` ('type' & 'value') Examples ======== >>> from sympy import fcode >>> from sympy.codegen.ast import integer, real >>> from sympy.codegen.fnodes import array >>> arr = array('a', '*', 'in', type=integer) >>> print(fcode(arr.as_Declaration(), source_format='free', standard=2003)) integer*4, dimension(*), intent(in) :: a >>> x = array('x', [3, ':', ':'], intent='out', type=real) >>> print(fcode(x.as_Declaration(value=1), source_format='free', standard=2003)) real*8, dimension(3, :, :), intent(out) :: x = 1 rz/Got an unexpected Attribute argument as dim: %sN)inoutinout)rr) rGrrYr!rrlistrrrrr rd)symboldimintentrrrs r'arrayrNs:#y!! sx==K ' [NQTUXQYQYYZZ Z [o KK3% E  )Z> > Y%j<PPQWXF V @e5AAAAE????r*cht|trt|nt|Sr$)rGrYrrr=s r' _printabler{s'$S#.. @6#;;;GCLL@r*c>tdt|gS)a Creates an AST node for a function call to Fortran's "allocated(...)" Examples ======== >>> from sympy import fcode >>> from sympy.codegen.fnodes import allocated >>> alloc = allocated('x') >>> fcode(alloc, source_format='free') 'allocated(x)' allocatedrr)rs r'rrs  j&7&7%8 9 99r*ctdt|g|rt|gngz|rt|gngzS)ap Creates an AST node for a function call to Fortran's "lbound(...)" Parameters ========== array : Symbol or String dim : expr kind : expr Examples ======== >>> from sympy import fcode >>> from sympy.codegen.fnodes import lbound >>> lb = lbound('arr', dim=2) >>> fcode(lb, source_format='free') 'lbound(arr, 2)' lboundrrrkinds r'rrs_(  E  ! )*S//  r +# +*T     -  r*ctdt|g|rt|gngz|rt|gngzS)Nuboundrrs r'rrs]  E  ! )*S//  r +# +*T     -  r*chtdt|g|rt|gngzS)aR Creates an AST node for a function call to Fortran's "shape(...)" Parameters ========== source : Symbol or String kind : expr Examples ======== >>> from sympy import fcode >>> from sympy.codegen.fnodes import shape >>> shp = shape('x') >>> fcode(shp, source_format='free') 'shape(x)' shaper)sourcers r'rrsD&  F  # +*T     -  r*ctdt|g|rt|gngz|rt|gngzS)a Creates an AST node for a function call to Fortran's "size(...)" Examples ======== >>> from sympy import fcode, Symbol >>> from sympy.codegen.ast import FunctionDefinition, real, Return >>> from sympy.codegen.fnodes import array, sum_, size >>> a = Symbol('a', real=True) >>> body = [Return((sum_(a**2)/size(a))**.5)] >>> arr = array(a, dim=[':'], intent='in') >>> fd = FunctionDefinition(real, 'rms', [arr], body) >>> print(fcode(fd, source_format='free', standard=2003)) real*8 function rms(a) real*8, dimension(:), intent(in) :: a rms = sqrt(sum(a**2)*1d0/size(a)) end function sizerrs r'rrs_(  E  ! )*S//  r +# +*T     -  r*ctdt|t|g|rt|gngz|rt|gngzS)z Creates an AST node for a function call to Fortran's "reshape(...)" Parameters ========== source : Symbol or String shape : ArrayExpr reshaper)rrpadorders r'rrsi  F  Z../! )*S//  r + # +*U     -  r*cFtd|rt|gngS)a Creates an Attribute ``bind_C`` with a name. Parameters ========== name : str Examples ======== >>> from sympy import fcode, Symbol >>> from sympy.codegen.ast import FunctionDefinition, real, Return >>> from sympy.codegen.fnodes import array, sum_, bind_C >>> a = Symbol('a', real=True) >>> s = Symbol('s', integer=True) >>> arr = array(a, dim=[s], intent='in') >>> body = [Return((sum_(a**2)/s)**.5)] >>> fd = FunctionDefinition(real, 'rms', [arr, s], body, attrs=[bind_C('rms')]) >>> print(fcode(fd, source_format='free', standard=2003)) real*8 function rms(a, s) bind(C, name="rms") real*8, dimension(s), intent(in) :: a integer*4 :: s rms = sqrt(sum(a**2)/s) end function bind_C)rr)r!s r'rrs%6 X=t ~~2 > >>r*cNeZdZdZdxZZdeiZee Z ee Z dS)GoToa Represents a goto statement in Fortran Examples ======== >>> from sympy.codegen.fnodes import GoTo >>> go = GoTo([10, 20, 30], 'i') >>> from sympy import fcode >>> fcode(go, source_format='free') 'go to (10, 20, 30), i' )labelsrrN) r+r,r-r.r/r0rrOr2r _construct_labelsrrr4r*r'rrsL  -,I~H$ Y//"l7++OOOr*rc8eZdZdZdxZZdeiZee Z dS) FortranReturnaK AST node explicitly mapped to a fortran "return". Explanation =========== Because a return statement in fortran is different from C, and in order to aid reuse of our codegen ASTs the ordinary ``.codegen.ast.Return`` is interpreted as assignment to the result variable of the function. If one for some reason needs to generate a fortran RETURN statement, this node should be used. Examples ======== >>> from sympy.codegen.fnodes import FortranReturn >>> from sympy import fcode >>> fcode(FortranReturn('x')) ' return x' ) return_valuerN) r+r,r-r.r/r0rrOr2r_construct_return_valuer4r*r'rr,s@(,+I%H*l733r*rceZdZdZdZdS) FFunctionMc |jj}|jd|jkrt d||jfzd|dt|j|j S)Nstandardz%s requires Fortran %d or newerz{}({})z, ) __class__r+ _settings_required_standardNotImplementedErrorformatrrc_printrL)rrr!s r'_fcodezFFunction._fcodeIs|~&  Z (4+B B G%&G'+T-D&E'FGG GtTYYs7>49/M/M%N%NOOOr*N)r+r,r-rrr4r*r'rrFs.PPPPPr*rceZdZdZdS) F95Function_N)r+r,r-rr4r*r'rrQsr*rceZdZdZdZdS)isignz/ Fortran sign intrinsic for integer arguments. rNr+r,r-r.nargsr4r*r'rrUs99 EEEr*rceZdZdZdZdS)dsignz8 Fortran sign intrinsic for double precision arguments. rNrr4r*r'rrZsBB EEEr*rceZdZdZdZdS)cmplxz& Fortran complex conversion function. rNrr4r*r'rr_s00 EEEr*rceZdZdZdZdS)rz Fortran kind function. rtNrr4r*r'rrd"" EEEr*rceZdZdZdZdS)mergez Fortran merge function Nrr4r*r'rrirr*rceZdZdZdZdZdS)_literalNc>d|j|zd\}}|dd}|d|ddd}}|dkrdn|}|pd|jz|z|pdzS) Nz%.{}ee0.rrt+)r _decimalssplitstriprstriplstrip_token)rrrLkwargsmantissasgnd_exex_sgnex_nums r'rz_literal._fcoders$^^DN;;dBII#NN'>>#&&--c22 WQRR[%7%7%<%<}0&C4;.76=SIIr*)r+r,r-rrrr4r*r'rrns2 FIJJJJJr*rceZdZdZdZdZdS) literal_spz' Fortran single precision real literal r Nr+r,r-r.rrr4r*r'rrzs11 FIIIr*rceZdZdZdZdZdS) literal_dpz' Fortran double precision real literal dNrr4r*r'rrs11 FIIIr*rcLeZdZdxZZeedZeeZ eeZ dS)sum_rrmaskrrN r+r,r-r/r0rrOr2r_construct_array_construct_dimr4r*r'rrD22IT**H#|G,,!\'**NNNr*rcLeZdZdxZZeedZeeZ eeZ dS)product_rrNrr4r*r'rrrr*rr$)NN)Jr.sympy.codegen.astrrrrrrr r r sympy.core.basicr sympy.core.containersrsympy.core.exprrsympy.core.functionrsympy.core.numbersrrsympy.core.symbolrsympy.core.sympifyr sympy.logicrrsympy.utilities.iterablesrrrrrrrr r6r?rArTr`rjrnr}rrassumed_extentr assumed_sizerrrrrrrrrrrrrrrrrrrrrrrr4r*r'rs#"""""'''''' ((((((--------!!!!!!&&&&&&########......y Ik " " Ik " " Y| $ $ y(( i && BBBBBeBBB*!!!!!!!!( ~~~~~%~~~.GGGGGUGGG<########>99999U999""M"M"M"M"M"M"M"MJ22222u222&,,,,,E,,,077777U777B . . .Fy~~ +@Rt$+@+@+@+@+@ZAAA : : : 848$????:,,,,,5,,,&44444E4444PPPPPPPP)I I I 9 K J J J J Ju J J J  +++++5$++++++++ud+++++r*