---
title: "Predicates"
canonical: "https://docs.magma-maths.org/v2.30-1/CommutativeAlgebra/ModulesOverMultivariateRings/predicates.html"
source: "https://docs.magma-maths.org/v2.30-1/CommutativeAlgebra/ModulesOverMultivariateRings/predicates.md"
part: "Commutative Algebra"
chapter: "Modules over Multivariate Rings"
breadcrumbs:
  - {"title": "Magma Handbook", "source": "https://docs.magma-maths.org/v2.30-1/index.md"}
  - {"title": "Commutative Algebra", "source": "https://docs.magma-maths.org/v2.30-1/CommutativeAlgebra/index-commutative-algebra.md"}
  - {"title": "Modules over Multivariate Rings", "source": "https://docs.magma-maths.org/v2.30-1/CommutativeAlgebra/ModulesOverMultivariateRings/index-modules-over-multivariate-rings.md"}
prev: {"title": "Basic Module Constructions", "source": "https://docs.magma-maths.org/v2.30-1/CommutativeAlgebra/ModulesOverMultivariateRings/basic_mod_cons.md"}
next: {"title": "Module Operations", "source": "https://docs.magma-maths.org/v2.30-1/CommutativeAlgebra/ModulesOverMultivariateRings/operations.md"}
intrinsics:
  - {"name": "IsZero", "signature": "IsZero(M): ModMPol -> ModMPol"}
  - {"name": "subset", "signature": "M subset N: ModMPol, ModMPol -> BoolElt"}
  - {"name": "eq", "signature": "M eq N: ModMPol, ModMPol -> BoolElt"}
  - {"name": "IsFree", "signature": "IsFree(M): ModMPol -> BoolElt"}
---

# Predicates

<a id="function-iszero-modmpol"></a>
## `IsZero(M): ModMPol -> ModMPol`

Given a module $M$, return whether $M$ is the zero module.

<a id="operation-op-subset-modmpol-modmpol"></a>
## `M subset N: ModMPol, ModMPol -> BoolElt`

Given compatible modules $M$ and $N$ (ie, embedded in the same ambient module), return whether $M$ is a submodule of $N$. This will generally involve module Gröbner basis and normal form computations to check that the generators of $M$ lie in $N$.

<a id="operation-op-eq-modmpol-modmpol"></a>
## `M eq N: ModMPol, ModMPol -> BoolElt`

Given compatible modules $M$ and $N$ (ie, embedded in the same ambient module), return whether $M$ equals $N$. The function checks that appropriate module Gröbner bases of $M$ and $N$ are equal.

<a id="function-isfree-modmpol"></a>
## `IsFree(M): ModMPol -> BoolElt`

Given an $R$-module $M$, return whether $M$ is free. $M$ is free iff $M$ is isomorphic to the module $R^k$ for some $k$. Such a $k$ need not equal the degree of $M$ but will equal the rank of $M$ (as defined in the next section) if $M$ is free. The function checks whether a minimised presentation of $M$ has trivial relations or not.
