hyperrogue/backed-map.cpp

// Hyperbolic Rogue -- Backed Maps
// Copyright (C) 2026- Zeno Rogue, see 'hyper.cpp' for details

// utilities for maps which are "backed" by hyperbolic map

#include "hyper.h"

namespace hr {

#if HDR
struct backed_map {
  map<heptagon*, vector<pair<heptagon*, transmatrix> > > what_at;
  map<heptagon*, pair<heptagon*, transmatrix>> where;
  hrmap *current_altmap;

  void initialize(heptagon *origin);
  void assign(heptagon *actual, heptagon *backer, transmatrix T);
  void reassign(heptagon *actual, heptagon *backer, transmatrix T);
  void rebase(heptagon*& backer, transmatrix& T);
  void redo_connection(heptagon *h, int d);
  void redo_connections_around(heptagon *actual, int qty);

  transmatrix relative_backer_matrix(heptagon *h2, heptagon *h1, const hyperpoint& hint);

  geometry_information *alt_cgip[2];

  geometry_information *find_alt_cgip();

  backed_map() { current_altmap = nullptr; }

  void store(gamedata *gd);
  void clear();
  void swapdim();
  };
#endif

/** @brief like adj, but in pure 
 *  not used by arcm itself, but used in fake arcm
 */
geometry_information *backed_map::find_alt_cgip() {
  auto& galt_cgip = alt_cgip[embedded_plane];
  if(galt_cgip) return galt_cgip;
  check_cgi();
  cgi.require_basics();
  return galt_cgip = cgip;
  }

void backed_map::initialize(heptagon *origin) {

  heptagon *alt = nullptr;
  transmatrix T = Id;

  if(mhyperbolic && WDIM == 2) {
    bool f = geom3::flipped;
    if(f) geom3::light_flip(false);
    dynamicval<eGeometry> g(geometry, gNormal);
    dynamicval<eVariation> gv(variation, eVariation::pure);
    dynamicval<geometry_information*> gi(cgip, cgip);
    cgip = find_alt_cgip();
    alt = init_heptagon(S7);
    alt->s = hsOrigin;
    alt->alt = alt;
    current_altmap = newAltMap(alt);
    T = lxpush(.01241) * spin(1.4117) * lxpush(0.1241) * Id;
    if(f) geom3::light_flip(true);
    }

  if(mhyperbolic && WDIM == 3) {
    #if CAP_BT
    dynamicval<eGeometry> g(geometry, gBinary3);
    bt::build_tmatrix();
    alt = init_heptagon(S7);
    alt->s = hsOrigin;
    alt->alt = alt;
    current_altmap = bt::new_alt_map(alt);
    T = xpush(.01241) * spin(1.4117) * xpush(0.1241) * cspin(0, 2, 1.1249) * xpush(0.07) * Id;
    #endif
    }

  assign(origin, alt, T);
  }

void backed_map::assign(heptagon *actual, heptagon *backer, transmatrix T) {
  where[actual] = make_pair(backer, T);
  what_at[backer].emplace_back(actual, T);
  }

void backed_map::reassign(heptagon *actual, heptagon *backer, transmatrix T) {
  auto& p = where[actual];
  auto& old = what_at[p.first];
  for(auto& v: old) if(v.first == actual) { swap(v, old.back()); old.pop_back(); break; }
  p = make_pair(backer, T);
  what_at[backer].emplace_back(actual, T);
  }

void backed_map::rebase(heptagon*& backer, transmatrix& T) {
  if(mhyperbolic && WDIM == 2) {
    dynamicval<int> uc(cgip->use_count, cgip->use_count+1);
    dynamicval<eGeometry> g(geometry, gNormal);
    dynamicval<eVariation> gv(variation, eVariation::pure);
    dynamicval<geometry_information*> gi(cgip, find_alt_cgip());
    dynamicval<hrmap*> cm(currentmap, current_altmap);
    current_altmap->virtualRebase(backer, T);
    }
  #if CAP_BT
  if(mhyperbolic && WDIM == 3) {
    dynamicval<eGeometry> g(geometry, gBinary3);
    dynamicval<hrmap*> cm(currentmap, current_altmap);
    current_altmap->virtualRebase(backer, T);
    }
  #endif
  if(euclid) {
    /* hash the rough coordinates as heptagon* alt */
    size_t s = size_t(T[0][LDIM]+.261) * 124101 + size_t(T[1][LDIM]+.261) * 82143;
    backer = (heptagon*) s;
    }
  }

EX int precision_policy = 3;

EX ld worst_precision_error;

#if HDR
struct hr_precision_error : hr_exception { hr_precision_error() : hr_exception("precision error") {} };
#endif

/** check if a and b are the same, testing for equality. Throw an exception or warning if not sure */
EX bool same_point_may_warn(hyperpoint a, hyperpoint b) {
  ld d = hdist(a, b);
  if(d > 1e-2) return false;
  if(d > 1e-3) throw hr_precision_error();
  if(d > 1e-6 && worst_precision_error <= 1e-6)
    addMessage("warning: precision errors are building up!");
  if(d > worst_precision_error) worst_precision_error = d;
  return true;
  }

EX void apply_precision_policy(cell *c, cell *from) {
  if(!(precision_policy & 2)) return;
  if(!from) return;
  auto bm = currentmap->get_backmap();
  if(!bm) return;
  auto h = from->master;
  auto h2 = c->master;
  for(int i=0; i<h->type; i++) if(h->move(i) == h2) { bm->redo_connection(h, i); return; }
  for(int i=0; i<h->type; i++) if(auto h3 = h->move(i)) {
    for(int j=0; j<h3->type; j++) if(h3->move(j) == h2) {
      bm->redo_connection(h, i);
      bm->redo_connection(h3, j);
      return;
      }
    }
  }

void backed_map::redo_connection(heptagon *h, int d) {
  auto h2 = h->move(d);
  auto p1 = where[h];
  fixmatrix(p1.second);
  heptspin hi(h, d);
  transmatrix T = p1.second * currentmap->adj(h, d);
  auto p2 = p1;
  p2.second = T;
  rebase(p2.first, p2.second);
  reassign(h2, p2.first, p2.second);
  }

void backed_map::redo_connections_around(heptagon *h, int qty) {
  set<heptagon*> visited;
  vector<heptagon*> q;
  auto enqueue = [&] (heptagon *h1) {
    if(visited.count(h1)) return false;
    visited.insert(h1);
    q.push_back(h1);
    return true;
    };
  enqueue(h);
  for(int i=0; i<qty; i++) {
    h = q[i];
    for(int d=0; d<h->type; d++) {
      auto h2 = h->move(d);
      if(!h2) continue;
      bool first = enqueue(h2);
      if(first) redo_connection(h, d);
      }
    }
  }

void backed_map::clear() {
  what_at.clear();
  where.clear();
  if(current_altmap) {
    dynamicval<eGeometry> g(geometry, gNormal);       
    dynamicval<eVariation> gv(variation, eVariation::pure);
    dynamicval<geometry_information*> gi(cgip, find_alt_cgip());
    delete current_altmap;
    current_altmap = NULL;
    }
  }

void backed_map::store(gamedata *gd) {
  gd->store(what_at); gd->store(where); gd->store(current_altmap);
  }

void backed_map::swapdim() {
  dynamicval<eGeometry> g(geometry, gNormal);
  dynamicval<eVariation> gv(variation, eVariation::pure);

  alt_cgip[0] = nullptr;
  alt_cgip[1] = nullptr;

  dynamicval<geometry_information*> gi(cgip, find_alt_cgip());

  for(auto& p: what_at) for(auto& pp: p.second) swapmatrix(pp.second);
  for(auto& p: where) swapmatrix(p.second.second);

  alt_cgip[0] = nullptr;
  alt_cgip[1] = nullptr;
  }

transmatrix backed_map::relative_backer_matrix(heptagon *h2, heptagon *h1, const hyperpoint& hint) {
  #if CAP_BT
  if(mhyperbolic && GDIM == 3) {
    dynamicval<eGeometry> g(geometry, gBinary3);
    dynamicval<hrmap*> cm(currentmap, current_altmap);
    return currentmap->relative_matrix(h2, h1, hint);
    }
  #endif
  if(mhyperbolic && GDIM == 2) {
    dynamicval<int> uc(cgip->use_count, cgip->use_count+1);
    dynamicval<eGeometry> g(geometry, gNormal);
    dynamicval<eVariation> gv(variation, eVariation::pure);
    dynamicval<geometry_information*> gi(cgip, find_alt_cgip());
    dynamicval<hrmap*> cm(currentmap, current_altmap);
    return currentmap->relative_matrix(h2, h1, hint);
    }
  return Id;
  }

ld min_precision_error = 1e-6;
ld precision_width = 4;

void draw_stress_map() {
  if(worst_precision_error < min_precision_error) return;
  auto bm = currentmap->get_backmap();
  if(!bm) return;
  int prec = grid_prec();
  dynamicval<ld> dv(vid.linewidth, vid.linewidth * precision_width);
  for(auto& p: gmatrix) {
    cell *c = p.first;
    const shiftmatrix& V = p.second;
    auto h = c->master;
    auto p1 = bm->where[h];
    for(int i=0; i<c->type; i++) {
      auto c2 = c->move(i);
      if(!c2 || c2 < c || !gmatrix.count(c2)) continue;
      auto h2 = c2->master;
      auto& p2 = bm->where[h2];
      auto p3 = p1;
      transmatrix T = Id;
      for(int j=0; j<h->type; j++) if(h->move(j) == h2) { T = currentmap->adj(h, j); goto done; }
      for(int j=0; j<h->type; j++) if(h->move(j)) for(int k=0; k<h->move(j)->type; k++) if(h->move(j)->move(k) == h2) { T = currentmap->adj(h, j) * currentmap->adj(h->move(j), k); goto done; }
      continue;
      done:
      p3.second = p1.second * T;
      bm->rebase(p3.first, p3.second);

      ld dist = hdist(p3.second * C0, p2.second * C0) + hdist(p3.second * lxpush0(1), p2.second * lxpush0(1));
      if(dist < 1e-20) dist = 1e-20;
      color_t col = gradient(0x80FF80, 0xFF0000, log(1e-20), log(dist), log(1e-4));
      if(WDIM == 2)
        gridline(V, get_corner_position(c, i), get_corner_position(c, (i+1)%c->type), darkena(col, 0, 0xFF), prec);
      else
        queuepoly(V * rgpushxto0(mid(C0, T * C0)), cgi.shSnowball, darkena(col, 0, 0xFF));
      }
    }
  vid.linewidth /= 4;
  }

int hk = addHook(hooks_frame, 100, draw_stress_map) + addHook(hooks_configfile, 100, [] {
  param_f(precision_width, "precision_viz_width")
  ->editable(0, 32, 0.5, "width of precision visualization", "", 'W');
  param_f(min_precision_error, "min_precision_error")
  -> editable(0, 1, log(10)/4, "minimum precision error to display", "Display a visualization of precision errors when they build up over this value.", 'M')
  ->set_sets([] { dialog::scaleSinh_big(); dialog::bound_low(0); })
  ->set_extra([] { add_edit(precision_width); });
  param_enum(precision_policy, "precision_policy", 3)
    ->editable({{"OFF", ""}, {"random", ""}, {"travel", ""}, {"both", ""}}, "precision policy", 'P')
    ->add_extra([] {
      if(currentmap->get_backmap())
        dialog::addHelp(XLAT("The current map uses a implementation that may occassionally lead to crashes due to numerical precision errors. These options can be used to eliminate these issues.") + "\n\n"
        + XLAT("'Random' randomizes the generation order which may break down specific paths causing imprecision.") + "\n\n"
        + XLAT("'Travel' builds the precise tree based on the path the player actually takes.")
        );
      else
        dialog::addHelp(XLAT("The current map is precise."));
      dialog::addSelItem(XLAT("current error"), format("%lg", worst_precision_error), 'R');
      dialog::add_action([] { worst_precision_error = 0; });
      add_edit(min_precision_error);
      });
  });

}