% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/gmds_layout_interface.R
\name{metric.mds}
\alias{metric.mds}
\title{Metric-MDS baseline layout for GMDS experiments}
\usage{
metric.mds(
  prepared = NULL,
  edges = NULL,
  n = NULL,
  adj_list = NULL,
  weight_list = NULL,
  edge_weights = NULL,
  dim = 2L,
  add = FALSE,
  eig = TRUE,
  diagnostics = TRUE,
  scale_mode = c("profiled", "identity", "user"),
  distance_floor = 1e-08,
  edge_length_epsilon = 1e-08,
  band_quantiles = c(1/3, 2/3)
)
}
\arguments{
\item{prepared}{Optional all-pairs prepared object returned by
[prepare.graph.geodesic.mds()] or [prepare.geodesic.kk()].
Edge-only objects from [prepare.edge.kk()] are intentionally rejected
because metric MDS requires a graph distance matrix.}

\item{edges}{Two-column edge matrix used when `prepared` is omitted.}

\item{n}{Number of vertices used when `prepared` is omitted.}

\item{adj_list}{Optional adjacency list used when `prepared` is omitted.}

\item{weight_list}{Optional edge-weight list parallel to `adj_list`.}

\item{edge_weights}{Optional positive edge weights parallel to `edges`.}

\item{dim}{Target embedding dimension. Values greater than 3 are supported
for GMDS and edge-KK workflows.}

\item{add, eig}{Passed to `stats::cmdscale()`.}

\item{diagnostics}{If `TRUE`, attach the common GMDS diagnostic panel. If
`FALSE` and raw graph inputs are supplied, `metric.mds()` uses a
distance-matrix-only preparation path and does not build the full
all-pairs path cache.}

\item{scale_mode}{Scale policy for edge, path, and chord targets:
`"profiled"` fits one scalar for each diagnostic family, `"identity"`
uses scale one, and `"user"` uses the corresponding supplied scale.}

\item{distance_floor}{Positive floor for relative residuals.}

\item{edge_length_epsilon}{Small stabilizer for fixed-path embedded lengths.}

\item{band_quantiles}{Two quantiles splitting graph distances into short,
mid, and long bands.}
}
\value{
A `"grip_gmds_layout"` object.
}
\description{
`metric.mds()` computes the current metric-MDS baseline using
`stats::cmdscale()` on the graph shortest-path distance matrix and returns a
common `"grip_gmds_layout"` result.
}
