Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
sagemath
GitHub Repository: sagemath/sagelib
Path: blob/master/sage/ext/python_slice.pxi
4038 views
    ############################################################################
    # 7.5.8 Slice Objects
    ############################################################################

cdef extern from "Python.h":
    ctypedef void PyObject

    # object PySlice_Type
    # The type object for slice objects. This is the same as slice and types.SliceType.
    
    bint PySlice_Check(object ob)
    # Return true if ob is a slice object; ob must not be NULL.

    object PySlice_New(object start, object stop, object step)
    # Return value:  New reference.
    # Return a new slice object with the given values. The start, stop,
    # and step parameters are used as the values of the slice object attributes
    # of the same names. Any of the values may be NULL, in which case the None
    # will be used for the corresponding attribute. Return NULL if the new object
    # could not be allocated.

    int PySlice_GetIndices(object slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
    # Retrieve the start, stop and step indices from the slice object slice,
    # assuming a sequence of length length. Treats indices greater than length as errors.
    
    # Returns 0 on success and -1 on error with no exception set (unless one of
    # the indices was not None and failed to be converted to an integer, in
    # which case -1 is returned with an exception set).
    
    # You probably do not want to use this function. If you want to use slice
    # objects in versions of Python prior to 2.3, you would probably do well to
    # incorporate the source of PySlice_GetIndicesEx, suitably renamed, in the
    # source of your extension
    
    int PySlice_GetIndicesEx(object slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength)
    # Usable replacement for PySlice_GetIndices. Retrieve the start, stop, and step
    # indices from the slice object slice assuming a sequence of length length,
    # and store the length of the slice in slicelength. Out of bounds indices are
    # clipped in a manner consistent with the handling of normal slices.
    #Returns 0 on success and -1 on error with exception set.