Skip to content

Latest commit

 

History

History
executable file
·
58 lines (33 loc) · 1.38 KB

misc.rst

File metadata and controls

executable file
·
58 lines (33 loc) · 1.38 KB

Obsolete Pointer Functions

.. function:: this_node


    Syntax:

        .. code-block::
            python

            h.this_node(x)
            h.this_node(x, sec=section)


    Description:
        Return a pointer (coded as a double) to the segment
        of *section* that
        contains location *x*.
        If no section is specified, it uses the currently accessed section; see
        :func:`cas`. If you wish to compute a segment number
        index where 1 is the first nonzero area segment and :data:`nseg` is the last
        nonzero area segment
        of the currently accessed section corresponding to position x use the
        hoc function


    .. warning::
        This function is useless and should be removed.


.. function:: this_section


    Syntax:

        .. code-block::
            python

            h.this_section(x)



    Description:
        Return a pointer (coded as a double) to the section which contains location 0 of the
        currently accessed section. This pointer can be used as the argument
        to :func:`push_section`. Functions that return pointers coded as doubles
        are unsafe with 64 bit pointers. This function has been superseded by
        :class:`SectionRef` and in Python the use of Section objects.

    See :meth:`~SectionRef.sec`.