vector.h 3.41 KB
Newer Older
1
/* vector.h: operations on vectors and points.
Sven Neumann's avatar
Sven Neumann committed
2 3 4
 *
 * Copyright (C) 1992 Free Software Foundation, Inc.
 *
5
 * This program is free software: you can redistribute it and/or modify
Sven Neumann's avatar
Sven Neumann committed
6
 * it under the terms of the GNU General Public License as published by
7
 * the Free Software Foundation; either version 3, or (at your option)
Sven Neumann's avatar
Sven Neumann committed
8 9 10 11 12 13 14 15
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
16
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
Sven Neumann's avatar
Sven Neumann committed
17
 */
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

#ifndef VECTOR_H
#define VECTOR_H

#include "types.h"

/* Our vectors are represented as displacements along the x and y axes.  */

typedef struct
{
  real dx, dy;
} vector_type;


/* Consider a point as a vector from the origin.  */
33
extern vector_type make_vector (const real_coordinate_type);
34 35

/* And a vector as a point, i.e., a displacement from the origin.  */
36
extern real_coordinate_type vector_to_point (const vector_type);
37 38 39 40 41


/* Definitions for these common operations can be found in any decent
   linear algebra book, and most calculus books.  */

42 43
extern real magnitude (const vector_type);
extern vector_type normalize (const vector_type);
44

45 46 47 48
extern vector_type Vadd (const vector_type, const vector_type);
extern real Vdot (const vector_type, const vector_type);
extern vector_type Vmult_scalar (const vector_type, const real);
extern real Vangle (const vector_type in, const vector_type out);
49 50 51 52

/* These operations could have been named `P..._vector' just as well as
   V..._point, so we may as well allow both names.  */
#define Padd_vector Vadd_point
53
extern real_coordinate_type Vadd_point
54 55 56
  (const real_coordinate_type, const vector_type);

#define Psubtract_vector Vsubtract_point
57
extern real_coordinate_type Vsubtract_point
58 59 60 61
  (const real_coordinate_type, const vector_type);

/* This returns the rounded sum.  */
#define IPadd_vector Vadd_int_point
62
extern coordinate_type Vadd_int_point
63 64 65
  (const coordinate_type, const vector_type);

/* Take the absolute value of both components.  */
66
extern vector_type Vabs (const vector_type);
67 68 69 70 71


/* Operations on points with real coordinates.  It is not orthogonal,
   but more convenient, to have the subtraction operator return a
   vector, and the addition operator return a point.  */
72
extern vector_type Psubtract
73 74 75 76 77 78 79 80 81 82 83
  (const real_coordinate_type, const real_coordinate_type);

/* These are heavily used in spline fitting, so we define them as macros
   instead of functions.  */
#define Padd(rc1, rc2)							\
  ((real_coordinate_type) { (rc1).x + (rc2).x, (rc1).y + (rc2).y })
#define Pmult_scalar(rc, r)						\
  ((real_coordinate_type) { (rc).x * (r), (rc).y * (r) })

/* Similarly, for points with integer coordinates; here, a subtraction
   operator that does return another point is useful.  */
84
extern vector_type IPsubtract
85
  (const coordinate_type, const coordinate_type);
86
extern coordinate_type IPsubtractP
87
  (const coordinate_type, const coordinate_type);
88
extern coordinate_type IPadd
89
  (const coordinate_type, const coordinate_type);
90 91
extern coordinate_type IPmult_scalar (const coordinate_type, const int);
extern real_coordinate_type IPmult_real
92
  (const coordinate_type, const real);
93
extern boolean IPequal (const coordinate_type, const coordinate_type);
94 95

#endif /* not VECTOR_H */