---
title: "Functions, Procedures, and Packages"
canonical: "https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/index-functions-procedures-and-packages.html"
source: "https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/index-functions-procedures-and-packages.md"
part: "The Magma Language"
chapter: "Functions, Procedures, and Packages"
breadcrumbs:
  - {"title": "Magma Handbook", "source": "https://docs.magma-maths.org/v2.30-1/index.md"}
  - {"title": "The Magma Language", "source": "https://docs.magma-maths.org/v2.30-1/MagmaLanguage/index-magma-language.md"}
prev: {"title": "Bibliography", "source": "https://docs.magma-maths.org/v2.30-1/MagmaLanguage/StatementsAndExpressions/bibliography.md"}
next: {"title": "Introduction", "source": "https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/introduction.md"}
---

<a id="function-procedure-package"></a>
<a id="chapfunc"></a>
# Functions, Procedures, and Packages

- [Introduction](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/introduction.md)
- [Functions and Procedures](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md)
  - [Functions](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#functions)
    - [`function`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-function-f-function-x1-xn-parameters-br-indent-statements-br-end-function)
    - [`function`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-function-function-f-x1-xn-parameters-br-indent-statements-br-end-function)
    - [`func`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-func-f-func-x1-xn-parameters-expression)
    - [`f := func< x₁, ..., xₙ, ... : parameters | expression >;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-f-func-x1-xn-parameters-expression-f-func-x1-xn-parameters-expression)
    - [Example: Recursive Functions](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#example-ex-eb1a18)
    - [Example: Function Parameters](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#example-ex-6cad0c)
    - [Example: Returning Undefined Values](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#example-ex-f4d48f)
    - [Example: Variadic Functions](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#example-ex-1b08eb)
  - [Procedures](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#procedures)
    - [`procedure`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-procedure-p-procedure-x1-xn-parameters-br-indent-statements-br-end-procedure)
    - [`procedure`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-procedure-procedure-p-x1-xn-parameters-br-indent-statements-br-end-procedure)
    - [`proc`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-proc-p-proc-x1-xn-parameters-expression)
    - [`p := proc< x₁, ..., xₙ, ... : parameters | expression >;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-p-proc-x1-xn-parameters-expression-p-proc-x1-xn-parameters-expression)
    - [Example: Procedures](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#example-ex-711cd6)
  - [The forward Declaration](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#the-forward-declaration)
    - [`forward`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#literal-literal-forward-forward-f)
    - [Example: Mutual Recursion with Forward Declarations](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/function-procedure.md#example-ex-09aa09)
- [Packages](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md)
  - [Introduction](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#introduction)
  - [Intrinsics](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#intrinsics)
    - [`intrinsic`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#literal-literal-intrinsic-intrinsic-name-arguments-return-values-br-comment-text-br-indent-statements-br-end-intrinsic)
    - [Example: Defining an Intrinsic for GCDs](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-82f54a)
  - [Resolving Calls to Intrinsics](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#resolving-calls-to-intrinsics)
    - [Example: Intrinsic Lookup for Overloaded Signatures](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-45ec7c)
  - [Attaching and Detaching Package Files](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#attaching-and-detaching-package-files)
    - [`Attach(F): MonStgElt`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#procedure-attach-monstgelt)
    - [`Detach(F): MonStgElt`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#procedure-detach-monstgelt)
    - [`freeze;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#literal-literal-freeze-freeze)
  - [Related Files](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#related-files)
  - [Importing Constants](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#importing-constants)
    - [`import "filename": ident_list;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#literal-literal-import-import-filename-ident-list)
    - [Example: Importing Constants from a Package](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-2ff439)
  - [Argument Checking](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#argument-checking)
    - [`require condition: print_args;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#literal-literal-require-require-condition-print-args)
    - [`requirerange v, L, U;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#literal-literal-requirerange-requirerange-v-l-u)
    - [`requirege v, L;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#literal-literal-requirege-requirege-v-l)
    - [Example: Argument Checking with require](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-216764)
  - [The Number of Results](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#the-number-of-results)
    - [`NumberOfResults() → RngIntElt, [ BoolElt ]`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#function-numberofresults)
    - [`Nresults() → RngIntElt, [ BoolElt ]`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#function-nresults)
    - [Example: Number of Results Requested](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-2485c6)
  - [Package Specification Files](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#package-specification-files)
    - [`AttachSpec(S): MonStgElt`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#procedure-attachspec-monstgelt)
    - [`DetachSpec(S): MonStgElt`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#procedure-detachspec-monstgelt)
    - [Example: Package Specification File](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-69025d)
  - [User Startup Specification Files](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#user-startup-specification-files)
    - [Example: User Startup Specification Files](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/package.md#example-ex-4f513b)
- [Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md)
  - [Predefined System Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#predefined-system-attributes)
  - [User-defined Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#user-defined-attributes)
    - [`AddAttribute(C, F): Cat, MonStgElt → ;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#function-addattribute-cat-monstgelt)
    - [`declare attributes C: F₁,...,Fₙ;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-declare-attributes-declare-attributes-c-f1-fn)
  - [Accessing Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#accessing-attributes)
    - [``S`fieldname: Str, Fieldname → Elt``](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-s-fieldname-str-fieldname-elt)
    - [```S`` N: Str, Str → Elt```](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-s-n-str-str-elt)
    - [``assigned S`fieldname: Str, Fieldname → BoolElt``](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#operation-operation-assigned-str-fieldname-boolelt)
    - [```assigned S`` N: Str, Str → BoolElt```](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#operation-operation-assigned-str-str-boolelt)
    - [``S`fieldname := expression;``](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-s-fieldname-expression)
    - [```S`` N := expression;```](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-s-n-expression)
    - [``delete  S`fieldname;``](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-delete-delete-s-fieldname)
    - [```delete  S`` N;```](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#literal-literal-delete-delete-s-n)
    - [`GetAttributes(C): Cat → [ MonStgElt ]`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#function-getattributes-cat)
    - [`ListAttributes(C): Cat`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/attribute.md#procedure-listattributes-cat)
- [User-defined Verbose Flags](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/verbose.md)
  - [`declare verbose F, m;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/verbose.md#literal-literal-declare-verbose-declare-verbose-f-m)
  - [Examples](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/verbose.md#examples)
    - [Example: System Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/verbose.md#example-ex-ca5e5c)
    - [Example: Interactive User Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/verbose.md#example-ex-659b09)
    - [Example: Package User Attributes](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/verbose.md#example-ex-280c05)
- [User-Defined Types](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md)
  - [Declaring User-Defined Types](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#declaring-user-defined-types)
    - [`declare type T;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#literal-literal-declare-type-declare-type-t)
    - [`declare type T: P₁, ..., Pₙ;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#literal-literal-declare-type-isa-declare-type-t-p1-pn)
    - [`declare type T[E];`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#literal-literal-declare-type-declare-type-t-e)
    - [`declare type T[E]: P₁, ..., Pₙ;`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#literal-literal-declare-type-isa-declare-type-t-e-p1-pn)
  - [Creating an Object](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#creating-an-object)
    - [`New(T): Type → T`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#function-new-type)
    - [`Clone(X): Any → Any`](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#function-clone-any)
  - [Special Intrinsics Provided by the User](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#special-intrinsics-provided-by-the-user)
  - [Examples](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#examples)
    - [Example: User-Defined Type for Rationals](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#example-ex-6e336c)
    - [Example: User-Defined Type for Direct Products](https://docs.magma-maths.org/v2.30-1/MagmaLanguage/FunctionsProceduresAndPackages/type.md#example-ex-5c6834)
