Generic package: Ada.Numerics.Generic_Complex_Types

Description

GNAT RUN-TIME COMPONENTS

A D A . N U M E R I C S . G E N E R I C _ C O M P L E X _ T Y P E S

S p e c

$Revision: 1.7 $

Copyright (C) 1992-1997 Free Software Foundation, Inc.

This specification is derived from the Ada Reference Manual for use with GNAT. The copyright notice above, and the license provisions that follow apply solely to the contents of the part following the private keyword.

GNAT is free software; you can redistribute it and/or modify it under terms of the GNU General Public License as published by the Free Soft- ware Foundation; either version 2, or (at your option) any later ver- sion. GNAT is distributed in the hope that it will be useful, but WITH- OUT 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 distributed with GNAT; see file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

As a special exception, if other files instantiate generics from this unit, or you link this unit with other files to produce an executable, this unit does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Public License.

GNAT was originally developed by the GNAT team at New York University. It is now maintained by Ada Core Technologies Inc (http://www.gnat.com).

Header

generic
   type Real is digits <>;

package Ada.Numerics.Generic_Complex_Types is

 
pragma Pure (Generic_Complex_Types);

Type Summary

Complex
Primitive Operations:  "*", "*", "*", "*", "*", "**", "**", "+", "+", "+", "+", "+", "+", "+", "+", "-", "-", "-", "-", "-", "-", "-", "-", "/", "/", "/", "/", "/", "abs", Argument, Argument, Compose_From_Cartesian, Compose_From_Cartesian, Compose_From_Cartesian, Compose_From_Polar, Compose_From_Polar, Conjugate, Im, Modulus, Re, Set_Im, Set_Re
Imaginary
Primitive Operations:  "*", "*", "*", "*", "*", "**", "+", "+", "+", "+", "+", "+", "-", "-", "-", "-", "-", "-", "/", "/", "/", "/", "/", "<", "<=", ">", ">=", "abs", Compose_From_Cartesian, Conjugate, Im, Set_Im

Constants and Named Numbers

i : constant Imaginary;
j : constant Imaginary;

Other Items:

type Complex is record
   Re, Im : Real'Base;
end record;
pragma Complex_Representation (Complex);
type Imaginary is private;
function Re (X : Complex)   return Real'Base;
function Im (X : Complex)   return Real'Base;
function Im (X : Imaginary) return Real'Base;
procedure Set_Re (X  : in out Complex;   Re : in Real'Base);
procedure Set_Im (X  : in out Complex;   Im : in Real'Base);
procedure Set_Im (X  :    out Imaginary; Im : in Real'Base);
function Compose_From_Cartesian (Re, Im : Real'Base) return Complex;
function Compose_From_Cartesian (Re     : Real'Base) return Complex;
function Compose_From_Cartesian (Im     : Imaginary) return Complex;
function Modulus (X     : Complex) return Real'Base;
function "abs"   (Right : Complex) return Real'Base renames Modulus;
function Argument (X : Complex)                    return Real'Base;
function Argument (X : Complex; Cycle : Real'Base) return Real'Base;
function Compose_From_Polar (
  Modulus, Argument : Real'Base)
  return Complex;
function Compose_From_Polar (
  Modulus, Argument, Cycle : Real'Base)
  return Complex;
function "+"       (Right : Complex) return Complex;
function "-"       (Right : Complex) return Complex;
function Conjugate (X     : Complex) return Complex;
function "+"       (Left, Right : Complex) return Complex;
function "-"       (Left, Right : Complex) return Complex;
function "*"       (Left, Right : Complex) return Complex;
function "/"       (Left, Right : Complex) return Complex;
function "**"      (Left : Complex; Right : Integer) return Complex;
function "+"       (Right : Imaginary) return Imaginary;
function "-"       (Right : Imaginary) return Imaginary;
function Conjugate (X     : Imaginary) return Imaginary renames "-";
function "abs"     (Right : Imaginary) return Real'Base;
function "+"       (Left, Right : Imaginary) return Imaginary;
function "-"       (Left, Right : Imaginary) return Imaginary;
function "*"       (Left, Right : Imaginary) return Real'Base;
function "/"       (Left, Right : Imaginary) return Real'Base;
function "**"      (Left : Imaginary; Right : Integer) return Complex;
function "<"       (Left, Right : Imaginary) return Boolean;
function "<="      (Left, Right : Imaginary) return Boolean;
function ">"       (Left, Right : Imaginary) return Boolean;
function ">="      (Left, Right : Imaginary) return Boolean;
function "+"       (Left : Complex;   Right : Real'Base) return Complex;
function "+"       (Left : Real'Base; Right : Complex)   return Complex;
function "-"       (Left : Complex;   Right : Real'Base) return Complex;
function "-"       (Left : Real'Base; Right : Complex)   return Complex;
function "*"       (Left : Complex;   Right : Real'Base) return Complex;
function "*"       (Left : Real'Base; Right : Complex)   return Complex;
function "/"       (Left : Complex;   Right : Real'Base) return Complex;
function "/"       (Left : Real'Base; Right : Complex)   return Complex;
function "+"       (Left : Complex;   Right : Imaginary) return Complex;
function "+"       (Left : Imaginary; Right : Complex)   return Complex;
function "-"       (Left : Complex;   Right : Imaginary) return Complex;
function "-"       (Left : Imaginary; Right : Complex)   return Complex;
function "*"       (Left : Complex;   Right : Imaginary) return Complex;
function "*"       (Left : Imaginary; Right : Complex)   return Complex;
function "/"       (Left : Complex;   Right : Imaginary) return Complex;
function "/"       (Left : Imaginary; Right : Complex)   return Complex;
function "+"       (Left : Imaginary; Right : Real'Base) return Complex;
function "+"       (Left : Real'Base; Right : Imaginary) return Complex;
function "-"       (Left : Imaginary; Right : Real'Base) return Complex;
function "-"       (Left : Real'Base; Right : Imaginary) return Complex;
function "*"       (Left : Imaginary; Right : Real'Base) return Imaginary;
function "*"       (Left : Real'Base; Right : Imaginary) return Imaginary;
function "/"       (Left : Imaginary; Right : Real'Base) return Imaginary;
function "/"       (Left : Real'Base; Right : Imaginary) return Imaginary;
private

   --  Implementation-defined ...

end Ada.Numerics.Generic_Complex_Types;
Generated on 2002-07-04 at 12:43:10 by AdaBrowse 2.12 using configuration file std.cfg.