% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/graph_helpers.R
\name{menger_sponge_surface_helpers}
\alias{menger_sponge_surface_helpers}
\alias{menger.sponge.surface.embedding}
\alias{menger.sponge.surface.graph}
\title{Weighted Menger sponge surface helpers}
\usage{
menger.sponge.surface.embedding(
  level = 2,
  surface = c("standard", "bulged", "twisted", "wavy"),
  amplitude = 0.2,
  freq = 2,
  twist = 0.6,
  x_scale = 1,
  y_scale = 1,
  z_scale = 1
)

menger.sponge.surface.graph(
  level = 2,
  surface = c("standard", "bulged", "twisted", "wavy"),
  amplitude = 0.2,
  freq = 2,
  twist = 0.6,
  x_scale = 1,
  y_scale = 1,
  z_scale = 1,
  normalize = c("median", "mean", "none")
)
}
\arguments{
\item{level}{Recursion depth. Must be at least \code{1}.}

\item{surface}{Cube-mask geometry family. One of \code{"standard"},
\code{"bulged"}, \code{"twisted"}, or \code{"wavy"}.}

\item{amplitude}{Finite deformation amplitude.}

\item{freq}{Positive modulation frequency used only when
\code{surface = "wavy"}.}

\item{twist}{Finite twist strength used only when
\code{surface = "twisted"}.}

\item{x_scale}{Positive horizontal scaling applied to the canonical cube
coordinates.}

\item{y_scale}{Positive vertical scaling applied to the canonical cube
coordinates.}

\item{z_scale}{Positive depth scaling applied to the canonical cube
coordinates.}

\item{normalize}{Normalization applied to the induced edge lengths. One of
\code{"median"}, \code{"mean"}, or \code{"none"}.}
}
\value{
\code{menger.sponge.surface.embedding()} returns an \code{n x 3} numeric
matrix with columns \code{x}, \code{y}, and \code{z}, where
\code{n = 20^level}.

\code{menger.sponge.surface.graph()} returns the same components as
\code{recursive.cube.mask.surface.graph()}, with \code{family} set to
\code{"menger.sponge"} and a family-specific class and label.
}
\description{
Convenience wrappers around \code{recursive.cube.mask.surface.*()} using the
classic \eqn{3 \times 3 \times 3} Menger-sponge keep-mask. These helpers
provide a named cubical 3D benchmark family whose vertices are occupied
subcubes and whose edges connect face-adjacent occupied cells.
}
