Return to phc.oxweave CVS log

Up to [local] / OpenXM / src / asir-contrib / packages / doc

An oxweave symbol is changed as follows:
C-texi -> C

/* $OpenXM: OpenXM/src/asir-contrib/packages/doc/phc.oxweave,v 1.4 2004/03/05 15:56:40 ohara Exp $ */


/*&C
@c DO NOT EDIT THIS FILE   oxphc.texi
@node PHC Functions,,, Top

*/
/*&ja
@chapter PHC $BH!?t(B

$B$3$N@a$G$O(B PHC pack $B$N(B ox $B%5!<%P(B @code{ox_sm1_phc}
$B$H$N%$%s%?%U%'!<%94X?t$r2r@b$9$k(B.
$B$3$l$i$N4X?t$O%U%!%$%k(B  @file{phc} $B$GDj5A$5$l$F$$$k(B.
@code{phc} $B$O(B @file{$(OpenXM_HOME)/lib/asir-contrib} $B$K$"$k(B.
*/
/*&en
@chapter PHC Functions

This chapter describes  interface functions for
PHC pack ox server @code{ox_sm1_phc}.
These interface functions are defined in the file @file{phc}.
The file @code{phc} is @*
at @file{$(OpenXM_HOME)/lib/asir-contrib}.
*/
/*&C
@example
@include opening.texi
[255] phc.start();
0
[257] phc.phc([x^2+y^2-4,x*y-1]);
The detailed output is in the file tmp.output.*
The answer is in the variable Phc.
0
[260] Phc ;
[[[-0.517638,0],[-1.93185,0]],
[[1.93185,0],[0.517638,0]],
[[-1.93185,0],[-0.517638,0]],
[[0.517638,0],[1.93185,0]]]
[261] 
@end example
*/
/*&C
Author of @code{PHC pack}: Jan Verschelde. @*
*/
/*&ja
$B;29M=q(B 1: Jan Verschelde,
PHCpack: A general-purpose solver for polynomial systems by
homotopy continuation".  ACM Transaction on Mathematical Softwares, 25(2): 
251-276, 1999. @*
$B;29M=q(B 2: Cox, D., O'Shea, Little, J.,  Using Algebraic Geometry,
Springer. Mixed volumes $B$K$D$$$F$N>O$r8+$h(B.
*/
/*&en
Reference 1: Jan Verschelde,
PHCpack: A general-purpose solver for polynomial systems by
homotopy continuation".  ACM Transaction on Mathematical Softwares, 25(2): 
251-276, 1999. @*
Reference 2: Cox, D., O'Shea, Little, J.,  Using Algebraic Geometry,
Springer. See the chapter on mixed volumes.
*/

/*&C
@menu
* phc.start::
* phc.phc::
@end menu

*/
/*&ja
@section $BH!?t0lMw(B
*/ 
/*&en
@section Functions
*/ 
/*&ja
@node phc.start,,, PHC Functions
@subsection @code{phc.start}
@findex phc.start
@table @t
@item phc.start()
::  Localhost $B$G(B @code{ox_sm1_phc} $B$r5/F0$9$k(B.
@end table

@table @var
@item return
$B@0?t(B
@end table

@itemize @bullet
@item Localhost $B$G(B @code{ox_sm1_phc} $B$r5/F0$9$k(B.
    $B5/F0$5$l$?(B @code{ox_sm1_phc} $B$N<1JLHV9f$rLa$9(B.
@item @code{Xm_noX =1} $B$H$7$F$*$/$H(B, @code{ox_sm1_phc} $BMQ$N(B debug window $B$,3+$+$J$$(B.
@item $B<1JLHV9f$O(B @code{Phc_proc} $B$K3JG<$5$l$k(B.
@end itemize
*/
/*&en
@node phc.start,,, PHC Functions
@subsection @code{phc.start}
@findex phc.start
@table @t
@item phc.start()
::  Start  @code{ox_sm1_phc} on the localhost.
@end table

@table @var
@item return
Integer
@end table

@itemize @bullet
@item Start @code{ox_sm1_phc} on the localhost.
    It returns the descriptor of @code{ox_sm1_phc}.
@item Set @code{Xm_noX = 1} to start @code{ox_sm1_phc} without a debug window.
@item The descriptor is stored in @code{Phc_proc}.
@end itemize
*/
/*&C
@example
P = phc.start()
@end example
*/
/*&ja
@table @t
@item $B;2>H(B
@code{ox_launch}, @code{phc}
@end table
*/
/*&en
@table @t
@item Reference
@code{ox_launch}, @code{phc}
@end table
*/


/*&ja
@node phc.phc,,, PHC Functions
@subsection @code{phc.phc}
@findex phc.phc
@table @t
@item phc.phc(@var{s}|proc=@var{p})
::  PHC pack $B$KBe?tJ}Dx<07O(B @var{s} $B$N2r$r$9$Y$F$b$H$a$F$/$l$k$h$&$KMj$`(B.
@end table

@table @var
@item return
$B$J$7(B
@item p
$B?t(B
@item s
$B%j%9%H(B
@end table

@itemize @bullet
@item
   $BBe?tJ}Dx<07O(B @var{S} $B$r%[%b%H%T!<K!$G2r$/$?$a$K(B PHC pack $B$r8F$V(B.
    PHC pack $B$r3+H/$7$?$N$O(B Jan Verschelde $B$G$"$k(B.
    $B%*%j%8%J%k$NG[I[85$O(B
    @code{www.mth.msu.edu/~jan} $B$G$"$k(B.
    PHC pack $B$OBe?tJ}Dx<07O$r2r$/$?$a$K$$$m$$$m$J@oN,$r$($i$V$3$H$,$G$-$k$,(B,
    $B$3$N%$%s%?%U%'!<%94X?t$G$O(B, black-box solver $B$7$+MQ$$$F$$$J$$(B.
    black-box solver $B$O0lHLE*$J@oN,$G$O$"$k$,(B, $BG=N(E*$G$O$J$$(B.
    $B$3$N4X?t$GBe?tJ}Dx<0$r2r$/$N$K<:GT$7$?$i(B, $B%*%j%8%J%k$N(B PHC pack $B$rMQ$$(B,
    $B$[$+$N@oN,$r;n$7$F$_$k$H$h$$(B.
@item
PHC $B$O:n6H%U%!%$%k(B @code{tmp.phc.out.pid}, @code{tmp.input.*}, 
@code{tmp.output.*} $B$r@8@.$9$k(B.
$B$3$3$G(B @code{pid} $B$O(B @code{ox_sm1_phc} $B$N%W%m%;%9HV9f$G$"$k(B.
$B%U%!%$%k(B @code{tmp.output.*} $B$K$O(B PHC pack $B$,$I$N$h$&$KJ}Dx<07O$r2r$$$?$N$+$N(B
$B>\$7$$>pJs$,$O$$$C$F$$$k(B.
@item
$BJQ?t$N?t$HJ}Dx<0$N?t(B @code{length(@var{s})} $B$OEy$7$/$J$$$H$$$1$J$$(B.
@end itemize
*/
/*&en
@node phc.phc,,, PHC Functions
@subsection @code{phc.phc}
@findex phc.phc
@table @t
@item phc.phc(@var{s}|proc=@var{p})
::  Ask PHC pack to find all the roots in the complex torus of the given systems of polynomials @var{s}
@end table

@table @var
@item return
Void
@item p
Number
@item s
List
@end table

@itemize @bullet
@item
 The server calls PHC pack to solve a system of algebraic equations S
    by homotopy methods.
    PHC pack has been developed by Jan Verschelde. See
    @code{www.mth.msu.edu/~jan} for the original distribution.
    The original PHC pack can choose several strategies to solve,
    but our phc interface uses only black-box solver, which is general
    and automatic but is not efficient. So, if you fails by our interface,
    try the other strategies via the original user interface.
@item
phc generates working files  tmp.phc.out.pid, tmp.input.*, tmp.output.*.
    Here, pid the process number of the server.
    The file @code{tmp.output.*} contains details informations on how PCH pack
    solves the system.
@item
The number of variables and the number of equations 
@code{length(@var{s})} must agree.
@end itemize
*/
/*&C

@noindent
Algorithm: 
Jan Verschelde,
PHCpack: A general-purpose solver for polynomial systems by
homotopy continuation".  ACM Transaction on Mathematical Softwares, 25(2): 
251-276, 1999.

@example
[232] P = phc.start();
0
[233] phc.phc([x^2+y^2-4,x*y-1]|proc=P);
The detailed output is in the file tmp.output.*
The answer is in the variable Phc.
0
[234] Phc;
[[[-1.93185,0],[-0.517638,0]],
 [[0.517638,0],[1.93185,0]],
 [[-0.517638,0],[-1.93185,0]],
 [[1.93185,0],[0.517638,0]]]

 [[x=[real, imaginary], y=[real,imaginary]],  the first solution
  [x=[real, imaginary], y=[real,imaginary]],  the second solution
  ...
@end example
*/
/*&ja
@table @t
@item $B;2>H(B
@code{ox_launch}, @code{phc.start}, @file{$(OpenXM_HOME)/bin/lin_phcv2}(original PHC pack binary for linux)
@end table
*/
/*&en
@table @t
@item Reference
@code{ox_launch}, @code{phc.start}, @file{$(OpenXM_HOME)/bin/lin_phcv2}(original PHC pack binary for linux)
@end table
*/